Skip to content

GitHub pages version #1

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.

Sign up for GitHub

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

Jump to bottom
Merged
jakemcivor merged 42 commits into from
Dec 16, 2025
Merged

GitHub pages version #1

jakemcivor merged 42 commits into from
Dec 16, 2025

Conversation

@bradleywell
Copy link
Collaborator

@bradleywell bradleywell commented Oct 29, 2025

Initial add of the GitHub Pages version of the design guide

@stephandobri
Added snap fit section.
d3ed51c 
Added section to design 3D printed snap fits. This includes:
- Images and their folder
- Writeup for snap fits
jakemcivor
jakemcivor requested changes Nov 26, 2025
View reviewed changes
Copy link
Member

@jakemcivor jakemcivor left a comment •
edited
Loading

Choose a reason for hiding this comment

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

  1. Populate the main readme.
  2. The footer or each page should include licensing information.
  3. The intro describes first / second / third section, but these don't match with the side navigation bar.
  4. Reference the 'how to contribute section' in home page and be clear this is meant to be living, community supported document.
  5. Add intro to How To Contribute page
  6. Add a more generic introduction to 3D Printing Design Tips
  7. Check for consistent capitalization (e.g., Hydra Research)

@bradleywell
Added info about markdown syntax
b1d9e2d 
Added info about markdown syntax
@jakemcivor
Copy link
Member

jakemcivor commented Dec 8, 2025

Looking very close.

  1. Is there a way to control / limit the width of the sidebar?
Browser screenshot showing sidebar occupying wide section of page
  1. Is it possible to have the licensing information at the bottom of the page content rather than above the TOC / links?

@jakemcivor
Update README.md
03e9554 
Flesh out introduction and add site link.
jakemcivor and others added 4 commits December 9, 2025 10:30
@jakemcivor
Revise contribution guide for clarity and inclusivity
d89dc1b 
Expanded instructions to clarify how to suggest corrections and add new pages. Added a welcoming introduction and guidance for contributors unfamiliar with GitHub, encouraging broader participation and making the process more accessible.
@jakemcivor
Revise and expand OpenAT Design Guide introduction
ccb1eed 
Rewrites the introduction to clarify what Open Assistive Technology (OpenAT) is, the purpose and audience of the guide, and how the guide is organized. Adds sections for context, improves readability, and emphasizes the guide's evolving nature and collaborative approach.
@bradleywell
Update _config.yml
4ddbbcd
@bradleywell
Removing links
a54667f
@jakemcivor
Update section links to use markdown and relative URLs
8b2d313 
Replaced plain text section references with markdown links using Jekyll's relative_url filter for improved navigation. Added a new 'How to Contribute' section link and updated section descriptions to match the new link format.
@jakemcivor
Update site title, description, and footer content
2963500 
Renamed the site to 'OpenAT Design Guide' and updated the description to reflect its focus on open assistive technology. Removed the OpenAT documentation template link from aux_links and clarified licensing language in the footer.
@jakemcivor
Change section headers to use H2 formatting
202c58d 
Updated section headers from H1 (#) to H2 (##) in 3D-Printing-Design-Tips.md for consistency and improved document structure.
@jakemcivor
Update heading levels in contribution guide
889ab73 
Changed top-level headings to second-level headings for 'Suggest a correction or improvement' and 'Adding a new page' sections to improve document structure and consistency.
@bradleywell
Adding duplicate CAD files
fa980e9 
Testing CAD files in a different location for download link
@jakemcivor
Merge remote-tracking branch 'origin/main' into Github-Pages-Version
8a78831
@jakemcivor
Fix title in 12-mm Tactile Switch documentation
fe21e04 
Corrected the document title from '#4 Sheet Metal Screw' to '12 mm Tactile Switch' to accurately reflect the content.
@jakemcivor jakemcivor self-requested a review December 16, 2025 19:17
@jakemcivor jakemcivor merged commit 9967ab3 into main Dec 16, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jakemcivor jakemcivor jakemcivor approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bradleywell @jakemcivor @stephandobri