-
Notifications
You must be signed in to change notification settings - Fork 16
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
Conversation
There was a problem hiding this 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
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. |
This reverts commit 8b33075.
Co-authored-by: Rob Jackson <[email protected]>
Co-authored-by: Rob Jackson <[email protected]>
Co-authored-by: Copilot <[email protected]>
@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 :) |
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. |
Just an fyi if your using windows and git The config option to fix this is
|
Recreating #147, but after rebasing it