Skip to content

Probably the biggest docs update in 5 years #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 44 commits into from
Jun 19, 2025
Merged

Probably the biggest docs update in 5 years #150

merged 44 commits into from
Jun 19, 2025

Conversation

rjackson
Copy link
Contributor

Recreating #147, but after rebasing it

I've ironed out all of my creases now, and present the biggest docs update since 2020.

It's not perfect, and there's still plenty more for people to get writing up, but this is my effort to get our docs into a somewhat useable state, and attempt to move us away from having 4 different sources of truth for everything, which is confusing and time consuming to navigate.

I have copy and pasted some bits directly from the google drive and intend to delete these documents off the google drive once they are merged.

I have also changed all file names to be snake_case, removing capitals where they appear.

I did not know how to set up the order of the wiki however, as things like 'getting started' would ideally appear at the top.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR significantly updates the documentation by consolidating sources, renaming files to snake_case, and rebranding content for Manchester Hackspace. Key changes include streamlined document titles and headings, the addition of new documentation for tools and emergency procedures, and removal of legacy content such as the Membership Rules and Hack the Space Days pages.

Reviewed Changes

Copilot reviewed 252 out of 252 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/equipment/cnc/index.md Renamed header from "Ox CNC" to a simplified "CNC" title
docs/equipment/cnc/chunky_cnc/inductions/*.md Updated headings and improved the description for induction docs
docs/equipment/chunky_cnc/index.md & getting_started.md Added introductory sections for clarity
docs/equipment/bringing_in_tools.md, borrowing_tools.md, banned_tools.md Added new tool-related documentation pages
docs/emergency_procedure.md Introduced a new emergency procedures guide
docs/adding_documentation.md Updated instructions and reworded content for documentation creation
docs/Operations/hack_the_space_days.md Removed outdated operations page
docs/Membership/Rules.md Removed legacy membership rules documentation
Comments suppressed due to low confidence (2)

docs/equipment/cnc/index.md:1

  • [nitpick] The header '# CNC' may be too generic after removing 'Ox CNC'. If this change is intentional for rebranding, consider adding additional context to distinguish it.
# CNC

docs/Membership/Rules.md:1

  • The complete removal of the Membership Rules document is a significant change; please ensure that any essential content is migrated elsewhere or that this deletion is fully intentional.
# Rules of Membership

@harvy4002 harvy4002 requested a review from a team May 11, 2025 15:59
@josephxtian
Copy link
Contributor

I'm at the limit of my github knowledge here, but are there any outstanding things that need changing here? I'd like to get this launched before it starts becoming outdated in itself. It will still be a work in progress as we have so many docs that need bringing together.
@rjackson @harvy4002 ?

@chris18890
Copy link
Member

I'm at the limit of my github knowledge here, but are there any outstanding things that need changing here? I'd like to get this launched before it starts becoming outdated in itself. It will still be a work in progress as we have so many docs that need bringing together. @rjackson @harvy4002 ?

@josephxtian it needed a rebase from master as files had been updated since you opeend the PR, I've rebased & force-pushed so should be good to go now :)

@chris18890 chris18890 merged commit 727f860 into master Jun 19, 2025
1 check passed
@chris18890 chris18890 deleted the docs_rewrite branch June 19, 2025 11:40
@peterdroberts
Copy link
Member

This has caused a number of links to break as they're case sensitive. For example on here https://docs.hacman.org.uk/equipment/woodwork/equipment/bandsaw/ there's a link to https://docs.hacman.org.uk/equipment/woodwork/equipment/Training/Bandsaw.md. This should now be https://docs.hacman.org.uk/equipment/woodwork/training/bandsaw/

A list of broken links can be seen at https://github.com/HACManchester/documentation/actions/runs/15756973399/job/44414464173 under job 'build mkdocs'. Basically every line that's a warning on there.

Lower case makes way more sense and I'm for it. I'll make a new issue covering these outstanding changes to be made.

@peterdroberts peterdroberts mentioned this pull request Jun 23, 2025
@Hecatron
Copy link
Contributor

Just an fyi if your using windows and git
sometimes it will default to ignoring when trying to change the upper / lower case of a filename. So it keeps the case of a new file initially checked in but then ignores when you try to change it.

The config option to fix this is

git config core.ignorecase false

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants