Skip to content

Add the Guides section for the released guide set - #5

Merged
integernick merged 2 commits into
mainfrom
guides-section
Sep 8, 2026
Merged

integernick merged 2 commits into
mainfrom
guides-section

Conversation

@integernick

Copy link
Copy Markdown
Member

The firmware repository gains a released guide set (docs/guides/, mirrored here by scripts/mirror-specs.sh --set guides into src/content/docs/guides/ at every release). This PR prepares the site for it.

  • astro.config.mjs: a Guides sidebar section between Getting Started and NXS; redirects from /reference/nxs-driver-development/ and /reference/nxs-cam-descriptors/ to the renamed pages (nxs-patch-authoring, nxs-camera-patches) that arrive with the next release.
  • src/content/docs/guides/index.md: the section's hand-authored landing page, which the mirror preserves.
  • src/content/docs/reference/index.md: the document list names the seven released documents.
  • src/content/docs/index.mdx: a Guides card and a pointer sentence; "driver" reads "patch" where it names the sensor add-on.
  • README.md: the guides directory is machine-managed like the reference.
    Not in this PR, because the token that opened it has no workflow scope: the same pre-release gate for the guides in .github/workflows/deploy.yml, in both the main and the staging steps, right after the reference gate's fi:
          if grep -lq "at pre-release" src/content/docs/guides/*.md 2>/dev/null; then
            find src/content/docs/guides -name '*.md' ! -name 'index.md' -delete
            echo "guides seed is pre-release - hidden from the site root"
          fi

Merge before the next rc export: the export's guides mirror step writes into src/content/docs/guides/ and expects this landing page beside it.

Companion: aliensense/redbrain#197.

@github-actions

github-actions Bot commented Sep 7, 2026 •

Copy link
Copy Markdown
Contributor

✅ Docs preview build success.

Workflow run: https://github.com/aliensense/nxs-docs/actions/runs/34193849042

…e pre-release gate, and redirects for two renamed reference pages
@integernick
integernick merged commit e091da9 into main Sep 8, 2026
2 checks passed
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