Files
handbook/mkdocs.yml
T
dsql f9e5e4f24d split Deploy into a hub + 3 sub-pages; inline comments over annotations
The Deploy page got long and the code annotations rendered inconsistently
(some as (n) numbers, some as clickable +, and a marker on a fully-commented
line made that line vanish). Fix both:

- Deploy is now a HUB (docs/deploy/index.md): the intro + collision rule +
  central-deploy note, then card links to three focused sub-pages. Deploy
  stays the single global-nav entry; sub-pages are not_in_nav, reached from
  the hub cards.
  - deploy/compose.md — compose convention, storage tiers, how deploy fills
    it in, subprocess/browser knobs, checklist
  - deploy/dockerfile.md — services-account image, COPY, layer caching, uv
  - deploy/secrets.md — keeping secrets out of the image
- Replace code annotations with INLINE COMMENTS on the compose/Dockerfile
  examples: everything visible at once, no + to click, and the commented
  MOUNTS_DIR line no longer disappears.
- Update inbound links (index card, standards, workflow, environments) to
  deploy/ and deploy/compose.md; nav Deploy -> deploy/index.md with
  not_in_nav for the sub-pages.

Verified in-browser: hub cards link correctly, sub-pages render with visible
inline comments (0 annotation markers), left nav shows only Deploy;
mkdocs build --strict clean (validates not_in_nav + all cross-links).

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-01 02:32:16 -04:00

65 lines
1.4 KiB
YAML

site_name: rethink development
site_description: Libraries, coding standards, and how to deploy on our network.
site_url: https://docs.rethinkstudios.io/
copyright: rethink development (handbook)
extra_css:
- stylesheets/extra.css
theme:
name: material
language: en
logo: assets/logo.svg
favicon: assets/logo.svg
palette:
scheme: slate
primary: custom
accent: custom
features:
- navigation.instant
- navigation.tracking
- navigation.top
- toc.follow
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
icon:
repo: fontawesome/brands/git-alt
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
- search
nav:
- Home: index.md
- Libraries: libraries.md
- Standards: standards.md
- Workflow: workflow.md
- Virtual environments: environments.md
- Deploy: deploy/index.md
# Deploy sub-pages are reached from the Deploy hub's cards, not the global nav.
not_in_nav: |
/deploy/compose.md
/deploy/dockerfile.md
/deploy/secrets.md