Skip to content

feat(docs-site): scaffold cougr-site repo with mdBook IA and content-sync from the core repo #249

Description

@salazarsebas

Part of #239

Background

No documentation site infrastructure exists. Per the repository strategy, the site lives in a cougr-site/ folder within this repository, kept separate from the crate root so it has its own build/deploy path, but it must not fork the content: docs/*.md in this repository remains the single source of truth, and cougr-site/ builds from it (via a sync step) rather than duplicating it by hand.

Objective

Build out a cougr-site/ folder in this repository with an mdBook skeleton implementing the 6-section information architecture from docs/strategy/12-documentation-architecture.md, and a working, documented mechanism that syncs docs/*.md content from this repository into cougr-site/src/ at build time (or on a defined schedule), without manual copy-paste.

References

In scope

  1. cougr-site/ folder in this repository, mdBook-based, with SUMMARY.md structured into the 6 sections: Start, Learn, Reference, Showcase, Design, Community.
  2. A sync step (a script or GitHub Action step) that reads the current docs/*.md, ARCHITECTURE.md, CHANGELOG.md, and docs/adr/*.md from this same repository's checkout and places them into the correct mdBook section, with front-matter/path rewriting as needed for mdBook's expectations. This must read the local checkout directly — it must not clone the repository over the network, since site and source now live in the same working tree.
  3. A documented decision on sync cadence and trigger (e.g. run on every push touching docs/** or cougr-site/**) — pick one, document why, and implement it.
  4. Placeholder pages for content not yet written (tutorial, boundary guide, etc., tracked in sibling sub-issues) so the site's navigation is complete even before every page has real content.
  5. Local build instructions in cougr-site/README.md.

Out of scope

  • The actual tutorial/pattern-guide content (separate sub-issues).
  • The showcase gallery generator (separate epic); this issue only reserves its place in the navigation.
  • Custom domain setup; a default GitHub Pages URL is sufficient for v1.

Definition of done

  • cougr-site/ exists in this repository, builds locally with mdbook build and mdbook serve.
  • Running the sync step against the current checkout produces an accurate, current copy of docs/*.md content in the site, without a network clone.
  • Site navigation matches the 6-section IA with no broken internal links.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programadvancedRequires deep Cougr knowledgedocumentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions