GitHub Pages Site Map Proposal 🌐¶
This repo is already a strong docs hub. A GitHub Pages site can make it easier to browse, search, and share.
Status¶
- Implemented in repo:
mkdocs.yml,docs/index.md,docs/contributing.md, and.github/workflows/pages.yml. - Implemented in repo: automatic "Next step" and "Related pages" footer links for major docs pages.
- Implemented in repo: expanded footer coverage across onboarding, resource, and drill pages.
- Pending: enable Pages in repository settings.
Why enable GitHub Pages¶
- One clean public URL for all study content.
- Better onboarding for new learners than browsing raw repo paths.
- Easier mobile reading and sharing with classes or study groups.
- Room to add navigation, search, and category pages without changing content.
Recommended structure¶
Use a docs-first site layout with these top-level sections:
- Home
- Start Here
- Study Paths
- Resources
- Cheatsheets
- Templates
- Timeline Gallery
- Contributing
Content mapping¶
Home¶
README.md(hero, quick start, core navigation)
Start Here¶
docs/authors.mddocs/books.mddocs/plan/week-zero-kickoff.md
Study Paths¶
docs/plan/study-plans.mddocs/plan/progression-paths.mddocs/resources/navigation-map.md
Resources¶
docs/resources/learning-resources.mddocs/resources/media-watchlists.mddocs/resources/access-alternatives.mddocs/resources/discussion-prompt-bank.mddocs/resources/source-freshness-log.md
Cheatsheets¶
docs/cheatsheets/argument-analysis-cheat-sheet.mddocs/cheatsheets/logic-drills.mddocs/cheatsheets/one-page-study-sheet.mddocs/cheatsheets/thinker-comparison-sheet.mddocs/cheatsheets/philosopher-quick-map.md
Templates¶
docs/templates/weekly-study-checklist.mddocs/templates/objection-reply-lab.mddocs/templates/exam-response-template.md
Timeline Gallery¶
docs/resources/timeline-gallery.mddocs/assets/philosophy-timeline.svgdocs/assets/timelines/(period visuals)
Contributing¶
CONTRIBUTING.mddocs/specs/edition-selection-spec.mddocs/plan/enrichment-roadmap.md
Linking strategy¶
- Keep one canonical hub per section (no orphan pages).
- Add "Next step" links at the end of each page.
- Add "Related pages" blocks for cross-topic jumps.
- Keep path names stable and short.
- Link images through relative paths so they work in both repo and site builds.
Suggested implementation path¶
- Enable GitHub Pages from Actions.
- Build with
mkdocs-material(fast setup, built-in search, clean nav). - Add
mkdocs.ymlnav using the mapping above. - Add a deploy workflow on push to
main. - Add a README badge linking to the live site.
Minimal acceptance criteria¶
- All major docs pages appear in top nav.
- No dead links in site build.
- Home page points to "Start Here" and "Study Paths".
- Mobile layout remains readable.