Skip to content

docs: finalize paths, Academy, repository guides, and site layout - #17

Merged
BotshareAI merged 1 commit into
mainfrom
docs/align-paths-and-layout
Sep 1, 2026
Merged

docs: finalize paths, Academy, repository guides, and site layout#17
BotshareAI merged 1 commit into
mainfrom
docs/align-paths-and-layout

Conversation

@BotshareAI

@BotshareAI BotshareAI commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Summary

This is the final documentation consolidation PR for the current site cycle.

Navigation and terminology

  • use Paths consistently in the requested order: Domain Expert, Beginner, Integrator, Builder, Developer, Entrepreneur
  • replace the primary Operator role with Domain Expert
  • remove the redundant one-item Start Here sidebar
  • align Academy navigation and content for Programs 1, 2, and 3
  • preserve former /tracks/ and pre-migration routes through redirects
  • add explicit titles to index pages so tabs, search and social metadata do not show Index
  • simplify breadcrumbs to Home + at most the final parent + current page
  • restore reader-path chips using the agreed role names

Layout

  • render Markdown tables as true full-width tables
  • use a deliberate 24/76 first-column split, consistent padding and borders
  • allow horizontal scrolling only when a narrow viewport cannot fit the table
  • keep journey diagrams on one horizontal line with controlled overflow

Reader-facing content

  • replace generator-style text on every section index with reader-facing planned coverage and completion criteria
  • replace the eight primary stage placeholders with substantive introductions, reading order, outcomes and honest maturity boundaries
  • add repository-grounded overview pages for platform software, hardware, firmware, UI, interfaces, release and workspace manifest
  • add /llms.txt with canonical routes and interpretation rules
  • clarify that repositories own exact versions, parameters, source and contracts, while the knowledge hub explains meaning, choice, workflows and verification

Capability honesty

The content reflects current repository state: mobile simulation/navigation/docking is active but experimental; real-robot drivers and acceptance remain in progress; hardware documentation is experimental/documentation-first with explicit safety gaps; upper-body and manipulation work is planned and simulation-first; v0.0.1 is the frozen public release.

Validation

  • scripts/check_docs.sh: passes with 0 errors and 0 warnings
  • git diff --check: passes
  • JavaScript syntax check: passes
  • all 315 Markdown navigation targets exist
  • all published local Markdown links resolve; intentional template placeholders are excluded
  • all section index pages have explicit titles
  • no generator-style prompt wording remains on section index pages

The reported stale root is consistent with cached or incomplete prior deployment. This PR changes the root page and will force a clean full-site GitHub Pages artifact deployment after merge.

Signed-off-by: Alex Reznichenko info@botshare.ai

Signed-off-by: Alex Reznichenko <info@botshare.ai>
@BotshareAI
BotshareAI merged commit 4e038ec into main Sep 1, 2026
4 checks passed
@BotshareAI BotshareAI changed the title docs: align paths, roles, Academy navigation, and layout docs: finalize paths, Academy, repository guides, and site layout Sep 1, 2026
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.

1 participant