Redesign documentation styling and reorganize manual structure#1089
Merged
Redesign documentation styling and reorganize manual structure#1089
Conversation
- Replace Roboto with Inter + JetBrains Mono to match landing page typography
- Port landing page design tokens (colors, shadows, radii) into docs CSS
- Add subtle dot-grid background, amber glow, and terminal theme overrides
- Style code blocks, admonitions, tables, sidebar, and links coherently
- Add h1 accent underline and dashed hr matching landing page motifs
- Reorganise index.rst toctrees into four Diataxis sections:
Tutorials → installation, getting_started
How-to Guides → troubleshooting, contributing
Reference → manifest, manual, changelog, legal
Explanation → vendoring, alternatives, internal
- Add sphinx_design extension to conf.py (already used by landing page)
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
- features/add-project-through-cli.feature now contains only the four
non-interactive scenarios (plain add, auto-rename, dst guessing, overrides)
- features/interactive-add.feature is a new file with all eight interactive
scenarios (guided wizard, tag, src, ignore, update, abort, empty-src,
pre-filled fields)
- doc/manual.rst Add section now has two subsections:
Non-interactive: add.cast + scenario-include for add-project-through-cli.feature
Interactive: interactive-add.cast + scenario-include for interactive-add.feature
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
- Replace plain prose sections with sphinx_design grids and cards:
• Benefits → 2×2 icon-card grid in band-tint section
• Costs → 2×2 icon-card grid in band-mint section
• Languages → 3-column grid of language cards
• Conclusion → tinted full-width card
• Best practices → 9 full-width cards each with a Material icon title
• Real-world projects → two band grids with linked cards
• Further Reading → icon-prefixed bullet list
- Add band-tint / band-mint CSS, sd-card / stat-card / card-tinted /
sd-bg-dark rules, and sd-text-primary colour to docs custom.css
(mirrors the landing page component library)
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
README.md:
- Tagline: "DFetch can manage dependencies" → "Vendor dependencies without the pain."
- Opening paragraph: internal rationale → user-facing pitch matching landing page
("copies source code directly...no Git submodules, no lock-in")
- "What Dfetch Does" bullets: add supply-chain, SBOM, patch stack, dfetch import;
drop vague items; lead with the strongest differentiators
- "DFetch" → "Dfetch" throughout
- "Github" → "GitHub"
doc/index.rst:
- OG/Twitter title: "Dfetch - a source-only no-hassle project-dependency aggregator"
→ "Dfetch — Vendor dependencies without the pain" (em-dash, landing page tagline)
- OG/Twitter description: aligned to landing page wording
("No submodules, no lock-in, supply-chain ready.")
- Sphinx meta description: aligned to landing page wording
- Keywords: add "supply chain, sbom, license compliance"; drop "fetch tool,
package manager, multi-project, monorepo"
- H1 subtitle: aligned to landing page tagline
- Intro paragraph: replaced internal backstory with user-facing pitch +
supply-chain and patch-stack highlights
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
check.puml / update.puml: - Remove monochrome true and Frutiger font - Activity nodes: white fill, amber (#c2620a) border, 1.5px, rounded corners - Decision diamonds: mint tint (#eff6fa) fill, accent blue (#4e7fa0) border, accent-dark text (#3a6682) - Arrows / labels: muted grey (#78716c) - Start circle: amber; end circle: charcoal - Partitions (update.puml): warm tint fill (#fef8f0), muted border (#e7e0d8), small bold uppercase label in muted grey - Font: Arial (closest available to Inter in PlantUML) - Background: transparent so body dot-grid shows through custom.css: - img[src*="plantweb"] rule: white card with border, rounded corners, box-shadow, and generous padding — matches the sd-card / admonition style https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
Commands are now organised from basic to advanced:
Foundational — Init, Import, Add, Check, Update
The complete everyday workflow: create/migrate a manifest,
register dependencies, check versions, fetch them.
Patching — Diff, Update patch, Format patch
First-class patch workflow: capture, reapply, and export
local changes while staying syncable with upstream.
CI/CD Integration — Reporting (Jenkins/SARIF/Code Climate), Report/SBOM
Machine-readable output for automated pipelines, security
toolchains, and compliance audits.
The Check Reporting sub-sections are moved out of Check and
into this group so they sit next to Report/SBOM where readers
looking for integration topics expect them.
Utilities — Freeze, Environment, Validate
Supporting commands: pin versions, verify setup, validate manifest.
Other changes:
- Remove the "Introduction" heading; intro prose stays under the page title
- Separate groups with horizontal rules for visual breathing room
- Add a one-paragraph section description for each group
- Rewrite CLI Cheatsheet using the same four-group structure with
labelled bold headings instead of a flat list
- Update cheatsheet copy to match landing-page messaging
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
manual.rst — CLI Cheatsheet section:
- Replace flat bulleted list with a raw HTML 2×2 grid
- Four cards matching the manual's four groups:
Foundational → amber header (--primary)
Patching → slate-blue header (--accent)
CI/CD → warm-charcoal header (#1e1610, dark card style)
Utilities → warm-tint header (--bg-tint, softer)
- Each card has a title + tagline in the header
- Commands rendered as a two-column table: syntax (JetBrains Mono,
amber) | description (Inter, muted); optional args shown lighter
- Alternating row tint on even rows
custom.css — new .cheatsheet / .cs-* rules:
- CSS grid, 2-col on ≥700 px, 1-col on narrow viewports
- .cs-cmd code resets the inline-code badge style (no bg, no border)
- .cs-cmd em for optional args shown in --text-muted
- .cs-table overrides general table.docutils rules (no shadow, no radius)
- @media print: force background colours (print-color-adjust: exact),
drop shadows, keep 2-col layout, suppress link-URL decoration
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
HTML (manual.rst):
- Replace 4-separate-white-cards with a single dark terminal card
- Masthead: "df" amber badge logo + title + tagline +
syntax-legend pills (subcommand / --flag / <arg>)
- Two-column body (col 1: Foundational + Utilities,
col 2: Patching + CI/CD) split by a hairline
- Section labels: coloured dot + ALL-CAPS name + muted tagline,
underlined in the section colour
(amber / blue / purple / green for the four groups)
- Every command hand-tagged with token spans:
.cs-kw dfetch → dim cream (de-emphasised)
.cs-sc subcommand → bright amber (hero colour)
.cs-fl --flag / -f → accent blue
.cs-ag <arg> / [opt] → muted grey
- Footer bar: docs + GitHub URL in small muted text
CSS (custom.css):
- Dark gradient background matching the landing-page dark card
- Masthead with amber-tinted background band
- Syntax legend token pills
- Section label colour variants: cs-l-primary / cs-l-accent /
cs-l-ci / cs-l-utility
- Row separators: 4% white hairlines
- Responsive: single-column below 720 px
- Print: force colour-adjust, drop shadow, suppress link URLs
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
- New commands.puml: mindmap with 4 colour-coded groups (Foundational amber, Patching blue, CI/CD purple, Utilities green) matching design tokens, placed right after the --help output in manual.rst - Wire check.puml and update.puml into their respective sections - Widen plantweb card max-width to 780px to give the mindmap room https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
- Remove duplicate diagram directives from manual.rst (check.puml and
update.puml are already embedded in their module docstrings)
- Expand thin module docstrings: init, report, environment, validate
now explain what the command does, its output, and next steps
- Fix validate.py circular self-reference ("Note that you can validate
using validate") — rewrite as a proper command description
- Fix typo in update.py: "don't what recommendations" → "want"
- Improve --no-recommendations help on check and update: explain sub-
manifest recursion instead of vague "ignore recommendations"
- Clarify --force on update: warn that local changes will be overwritten
- Fix reporter --help strings: consistent capitalisation (SARIF, GitHub,
GitLab), clearer verb ("Write a … report to <outfile>")
- Expand diff --revs and project help: show format, mention output file
- Expand format-patch -o help: document default and output filename
- Add SVN externals migration steps to import_.py matching the depth
of the Git submodules section; include nested-externals caveat
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
New "Design Guide" section under "Creating documentation" covers: - Colour palette: 8 swatches with token name, hex, role, and usage (primary amber, accent blue, near-black text, warm-gray muted, primary-dark, accent-dark, bg-tint cream, bg-mint cool) - Typography: two side-by-side specimens — Inter at all 6 weights and JetBrains Mono at 400/500 with usage guidance - CSS token reference table: all --primary/--accent/--text/--bg/ --border/--r/--shad tokens with colour dots and use descriptions - PlantUML skinparam guide: list-table mapping each diagram element (activity, diamond, arrow, partition, start node) to the correct token value so new diagrams stay visually consistent New CSS classes: .dg-palette, .dg-swatch*, .dg-type-grid/card/header/ body/specimen/weights, .dg-tokens (table overrides), .dg-dot https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
New file: doc/static/js/diataxis.js
- Classifies each page into Tutorial / How-to / Reference / Explanation
via a PAGE_SECTIONS map (keyed by filename without .html)
- Adds dxt-<section> class to <body> → CSS paints coloured top strip
- Injects a floating kind badge ("Tutorial", "How-to Guide", etc.) at
the top of div.body
- Finds sidebar p.caption elements by caption text, adds
dxt-caption-<section> and dxt-section-<section> classes
CSS additions (custom.css):
- Four new tokens: --dxt-tutorial (#c2620a), --dxt-howto (#4e7fa0),
--dxt-reference (#4a7a62 sage), --dxt-explanation (#7a5a9a purple)
- 4px coloured top border on div.body per section
- .dxt-badge pills: subtle tinted background + border in section colour
- Sidebar caption: coloured left border + tinted background + dot pip
+ caption text colour per section
- Sidebar links: section-coloured hover and bold active link
Design Guide updated with a 4-swatch row documenting each section
colour and a note on how to register new pages.
https://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
Contributor
WalkthroughLarge-scale documentation and design-system update: README rewrite, expanded and reorganized Sphinx docs (new how‑tos, reference pages, Diataxis structure), updated command docstrings/help text, new design CSS/JS and PlantUML assets, feature-test reorganization (split interactive add scenarios), and added font vendoring entries plus generated metadata files. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~40 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
features/add-project-through-cli.feature (1)
3-9:⚠️ Potential issue | 🟡 MinorFeature intro still implies confirmation for non-interactive add.
The description says entries are appended “after confirmation,” but this file now documents non-interactive behavior, which adds directly. Please align the intro wording to avoid user confusion.
✏️ Suggested wording update
- fills in sensible defaults (name, destination, default branch), shows a - preview, and appends the entry to ``dfetch.yaml`` after confirmation. + fills in sensible defaults (name, destination, default branch), shows a + preview, and appends the entry to ``dfetch.yaml`` directly.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@features/add-project-through-cli.feature` around lines 3 - 9, Update the feature intro to remove the implication of mandatory confirmation when using the non-interactive add command; locate the line describing "dfetch add <url>" and change the phrase "shows a preview, and appends the entry to ``dfetch.yaml`` after confirmation" to indicate that the command shows a preview and appends the entry (or appends immediately in non-interactive mode / when flags are provided), and keep the mention of flags (--name, --dst, --version, --src, --ignore) for pre-filling fields so the behavior matches the documented non-interactive flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@dfetch/commands/format_patch.py`:
- Around line 76-80: The help string for the output directory is incorrect: it
states the output will be named formatted-<project>.patch while the
implementation actually uses pathlib.Path(patch_file).name to preserve the
original patch filename. Update the help text (the help= argument in
format_patch.py where the directory argument is defined) to accurately describe
that the formatted patch will be written to the specified directory using the
original patch's basename (from pathlib.Path(patch_file).name), or alternatively
change the implementation to generate formatted-<project>.patch; pick one and
make the help text and the code (pathlib.Path(patch_file).name usage)
consistent.
In `@doc/static/css/custom.css`:
- Line 1: Remove the external Google Fonts `@import` from
doc/static/css/custom.css and update typography to use either system font stacks
or self-hosted font files: delete the `@import` line and change body font-family
to a system stack like -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif
and change code/monospace font-family to a stack like "Fira Code", Consolas,
monospace; if you prefer self-hosting, add `@font-face` rules that point to files
under _static/fonts/ for Inter and JetBrains Mono and reference those family
names in the existing body and code selectors instead of the Google Fonts
import.
- Around line 300-304: In the .sd-bg-dark rule swap the property order so
border-color comes before border-top-color (both with !important) to prevent the
shorthand from overriding the top-border accent; locate the .sd-bg-dark CSS
block and move the border-top-color declaration to appear after border-color so
the intended top border contrast is preserved.
- Around line 593-597: The CSS uses an undefined variable --shad-xl in the
.cheatsheet rule so the box-shadow is dropped; fix by defining --shad-xl in
:root (or update .cheatsheet to use an existing variable like --shad-lg or
provide a fallback such as var(--shad-xl, var(--shad-lg))). Update the :root
declaration to include --shad-xl with the intended shadow value or change the
.cheatsheet box-shadow to var(--shad-lg) so the cheatsheet card renders with the
expected shadow.
- Around line 128-140: The CSS currently sets overflow: hidden on div.highlight
which clips long code samples on narrow viewports; change the rule for
div.highlight to allow scrolling (e.g., remove overflow: hidden and/or set
overflow-x: auto) and ensure div.highlight pre has horizontal scrolling enabled
(e.g., overflow-x: auto and white-space: pre or pre-wrap as appropriate) so long
lines can be scrolled instead of clipped; update the selectors div.highlight and
div.highlight pre accordingly.
In `@doc/vendoring.rst`:
- Around line 332-334: The Sphinx cross-reference :ref:`Patch` in the text is
unresolved; fix it by either adding an explicit label for the patch section
(e.g. add a section anchor like ``.. _Patch:`` immediately before the
documentation section that describes the patch attribute/workflow) or by
changing the reference to point to the correct existing label (replace
``:ref:`Patch``` with ``:ref:`<existing-label>` where <existing-label> is the
actual target for the patch attribute/workflow); ensure the label you add or
reference matches the unique identifier used elsewhere and keep the surrounding
text referencing ``dfetch diff`` and the ``Check`` CI check unchanged.
---
Outside diff comments:
In `@features/add-project-through-cli.feature`:
- Around line 3-9: Update the feature intro to remove the implication of
mandatory confirmation when using the non-interactive add command; locate the
line describing "dfetch add <url>" and change the phrase "shows a preview, and
appends the entry to ``dfetch.yaml`` after confirmation" to indicate that the
command shows a preview and appends the entry (or appends immediately in
non-interactive mode / when flags are provided), and keep the mention of flags
(--name, --dst, --version, --src, --ignore) for pre-filling fields so the
behavior matches the documented non-interactive flow.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 1c06af86-0a98-4e53-a51c-1d6e3e067507
📒 Files selected for processing (23)
README.mddfetch/commands/add.pydfetch/commands/check.pydfetch/commands/diff.pydfetch/commands/environment.pydfetch/commands/format_patch.pydfetch/commands/import_.pydfetch/commands/init.pydfetch/commands/report.pydfetch/commands/update.pydfetch/commands/validate.pydoc/conf.pydoc/contributing.rstdoc/index.rstdoc/manual.rstdoc/static/css/custom.cssdoc/static/js/diataxis.jsdoc/static/uml/check.pumldoc/static/uml/commands.pumldoc/static/uml/update.pumldoc/vendoring.rstfeatures/add-project-through-cli.featurefeatures/interactive-add.feature
Comment on lines
+76
to
+80
| help=( | ||
| "Directory to write formatted patches to " | ||
| "(default: current working directory). " | ||
| "The output file is named formatted-<project>.patch." | ||
| ), |
Contributor
There was a problem hiding this comment.
Incorrect output filename pattern in help text.
The help text claims the output file is named formatted-<project>.patch, but the actual implementation at lines 130-132 uses pathlib.Path(patch_file).name, which preserves the original patch filename rather than following a formatted-<project>.patch pattern.
📝 Proposed fix for the help text
help=(
"Directory to write formatted patches to "
"(default: current working directory). "
- "The output file is named formatted-<project>.patch."
+ "The output filename is preserved from the input patch file."
),📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| help=( | |
| "Directory to write formatted patches to " | |
| "(default: current working directory). " | |
| "The output file is named formatted-<project>.patch." | |
| ), | |
| help=( | |
| "Directory to write formatted patches to " | |
| "(default: current working directory). " | |
| "The output filename is preserved from the input patch file." | |
| ), |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@dfetch/commands/format_patch.py` around lines 76 - 80, The help string for
the output directory is incorrect: it states the output will be named
formatted-<project>.patch while the implementation actually uses
pathlib.Path(patch_file).name to preserve the original patch filename. Update
the help text (the help= argument in format_patch.py where the directory
argument is defined) to accurately describe that the formatted patch will be
written to the specified directory using the original patch's basename (from
pathlib.Path(patch_file).name), or alternatively change the implementation to
generate formatted-<project>.patch; pick one and make the help text and the code
(pathlib.Path(patch_file).name usage) consistent.
Comment on lines
+128
to
+140
| div.highlight { | ||
| border-radius: var(--r-sm) !important; | ||
| overflow: hidden !important; | ||
| box-shadow: var(--shad-sm) !important; | ||
| border: 1px solid var(--border) !important; | ||
| } | ||
|
|
||
| div.highlight pre { | ||
| font-family: "JetBrains Mono", "Fira Code", "Cascadia Code", Consolas, monospace !important; | ||
| font-size: 0.875rem !important; | ||
| line-height: 1.7 !important; | ||
| padding: 1.25rem 1.5rem !important; | ||
| } |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
find . -name "custom.css" -type fRepository: dfetch-org/dfetch
Length of output: 129
🏁 Script executed:
wc -l ./doc/static/css/custom.cssRepository: dfetch-org/dfetch
Length of output: 93
🏁 Script executed:
sed -n '128,140p' ./doc/static/css/custom.cssRepository: dfetch-org/dfetch
Length of output: 458
🏁 Script executed:
grep -n "div.highlight\|\.highlight" ./doc/static/css/custom.css | head -30Repository: dfetch-org/dfetch
Length of output: 104
🏁 Script executed:
grep -r "overflow.*hidden\|div\.highlight" ./doc --include="*.css" --include="*.html" --include="*.md"Repository: dfetch-org/dfetch
Length of output: 1425
🏁 Script executed:
sed -n '1,150p' ./doc/static/css/custom.css | tail -50Repository: dfetch-org/dfetch
Length of output: 1217
🏁 Script executed:
grep -n "overflow" ./doc/static/css/custom.css | grep -A 2 -B 2 "div.highlight"Repository: dfetch-org/dfetch
Length of output: 43
🏁 Script executed:
sed -n '125,200p' ./doc/static/css/custom.cssRepository: dfetch-org/dfetch
Length of output: 2359
Don't allow long code samples to be clipped on narrow viewports.
div.highlight uses overflow: hidden, which clips content instead of allowing horizontal scroll. This prevents readers from seeing full commands and YAML blocks on narrower screens.
Suggested fix
div.highlight {
border-radius: var(--r-sm) !important;
- overflow: hidden !important;
+ overflow-x: auto !important;
+ overflow-y: hidden !important;
box-shadow: var(--shad-sm) !important;
border: 1px solid var(--border) !important;
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| div.highlight { | |
| border-radius: var(--r-sm) !important; | |
| overflow: hidden !important; | |
| box-shadow: var(--shad-sm) !important; | |
| border: 1px solid var(--border) !important; | |
| } | |
| div.highlight pre { | |
| font-family: "JetBrains Mono", "Fira Code", "Cascadia Code", Consolas, monospace !important; | |
| font-size: 0.875rem !important; | |
| line-height: 1.7 !important; | |
| padding: 1.25rem 1.5rem !important; | |
| } | |
| div.highlight { | |
| border-radius: var(--r-sm) !important; | |
| overflow-x: auto !important; | |
| overflow-y: hidden !important; | |
| box-shadow: var(--shad-sm) !important; | |
| border: 1px solid var(--border) !important; | |
| } | |
| div.highlight pre { | |
| font-family: "JetBrains Mono", "Fira Code", "Cascadia Code", Consolas, monospace !important; | |
| font-size: 0.875rem !important; | |
| line-height: 1.7 !important; | |
| padding: 1.25rem 1.5rem !important; | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/static/css/custom.css` around lines 128 - 140, The CSS currently sets
overflow: hidden on div.highlight which clips long code samples on narrow
viewports; change the rule for div.highlight to allow scrolling (e.g., remove
overflow: hidden and/or set overflow-x: auto) and ensure div.highlight pre has
horizontal scrolling enabled (e.g., overflow-x: auto and white-space: pre or
pre-wrap as appropriate) so long lines can be scrolled instead of clipped;
update the selectors div.highlight and div.highlight pre accordingly.
Comment on lines
+300
to
+304
| .sd-bg-dark { | ||
| background: linear-gradient(150deg, #1e1610 0%, #2d2018 100%) !important; | ||
| border-top-color: rgba(255, 255, 255, 0.12) !important; | ||
| border-color: rgba(255, 255, 255, 0.07) !important; | ||
| } |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check if the file exists and read the relevant lines
cat -n doc/static/css/custom.css | sed -n '295,310p'Repository: dfetch-org/dfetch
Length of output: 728
Move border-top-color after border-color to preserve the top-border accent.
The border-color shorthand sets all four borders, and since it comes after border-top-color in the cascade, it overrides the custom top border color. Reordering these properties will ensure the top border retains its intended contrast:
Fix
.sd-bg-dark {
background: linear-gradient(150deg, `#1e1610` 0%, `#2d2018` 100%) !important;
- border-top-color: rgba(255, 255, 255, 0.12) !important;
border-color: rgba(255, 255, 255, 0.07) !important;
+ border-top-color: rgba(255, 255, 255, 0.12) !important;
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| .sd-bg-dark { | |
| background: linear-gradient(150deg, #1e1610 0%, #2d2018 100%) !important; | |
| border-top-color: rgba(255, 255, 255, 0.12) !important; | |
| border-color: rgba(255, 255, 255, 0.07) !important; | |
| } | |
| .sd-bg-dark { | |
| background: linear-gradient(150deg, `#1e1610` 0%, `#2d2018` 100%) !important; | |
| border-color: rgba(255, 255, 255, 0.07) !important; | |
| border-top-color: rgba(255, 255, 255, 0.12) !important; | |
| } |
🧰 Tools
🪛 Stylelint (17.5.0)
[error] 303-303: Unexpected shorthand "border-color" after "border-top-color" (declaration-block-no-shorthand-property-overrides)
(declaration-block-no-shorthand-property-overrides)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/static/css/custom.css` around lines 300 - 304, In the .sd-bg-dark rule
swap the property order so border-color comes before border-top-color (both with
!important) to prevent the shorthand from overriding the top-border accent;
locate the .sd-bg-dark CSS block and move the border-top-color declaration to
appear after border-color so the intended top border contrast is preserved.
Comment on lines
+593
to
+597
| .cheatsheet { | ||
| background: linear-gradient(150deg, #1c1410 0%, #281a0f 100%); | ||
| border-radius: var(--r-lg); | ||
| box-shadow: var(--shad-xl); | ||
| overflow: hidden; |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, locate the CSS file
find . -name "custom.css" -type fRepository: dfetch-org/dfetch
Length of output: 129
🏁 Script executed:
# Check the file size first
wc -l ./doc/static/css/custom.css
# Then read lines 593-597
sed -n '593,597p' ./doc/static/css/custom.cssRepository: dfetch-org/dfetch
Length of output: 252
🏁 Script executed:
# Search for :root definition and shadow variables
rg -n "\-\-shad-" ./doc/static/css/custom.css | head -30Repository: dfetch-org/dfetch
Length of output: 748
🏁 Script executed:
# Search for --shad-xl anywhere in the repository
rg --type css "\-\-shad-xl"
# Also check the landing page CSS file to see its definitions
sed -n '1,50p' ./doc/landing-page/static/css/custom.css | rg -n "\-\-shad-"Repository: dfetch-org/dfetch
Length of output: 665
--shad-xl is used but never defined in this file.
:root only defines --shad-sm, --shad-md, and --shad-lg. With no fallback, this box-shadow declaration is dropped entirely, so the cheatsheet card renders flat.
🎯 Suggested fix
.cheatsheet {
background: linear-gradient(150deg, `#1c1410` 0%, `#281a0f` 100%);
border-radius: var(--r-lg);
- box-shadow: var(--shad-xl);
+ box-shadow: var(--shad-lg);
overflow: hidden;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/static/css/custom.css` around lines 593 - 597, The CSS uses an undefined
variable --shad-xl in the .cheatsheet rule so the box-shadow is dropped; fix by
defining --shad-xl in :root (or update .cheatsheet to use an existing variable
like --shad-lg or provide a fallback such as var(--shad-xl, var(--shad-lg))).
Update the :root declaration to include --shad-xl with the intended shadow value
or change the .cheatsheet box-shadow to var(--shad-lg) so the cheatsheet card
renders with the expected shadow.
Comment on lines
+332
to
+334
| *Dfetch* addresses this by providing a ``dfetch diff`` (:ref:`Diff`) command and a | ||
| ``patch`` (:ref:`Patch`) attribute in the manifest. It also has a CI check to detect | ||
| local changes using :ref:`Check`. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's look at the specific lines mentioned (332-334) and surrounding context
head -340 doc/vendoring.rst | tail -20Repository: dfetch-org/dfetch
Length of output: 889
🏁 Script executed:
# Search for any :ref: references to 'Patch' in the file
rg ':\s*ref:\s*`Patch`' doc/vendoring.rst -A 2 -B 2Repository: dfetch-org/dfetch
Length of output: 273
🏁 Script executed:
# Search for Patch label definitions (.. _Patch:) in all doc files
rg '\.\.\s+_Patch:' doc/ -A 2 -B 2Repository: dfetch-org/dfetch
Length of output: 43
🏁 Script executed:
# Search for "Patch" as a section header in the doc directory
rg '^Patch\s*$' doc/ -A 2 -B 2Repository: dfetch-org/dfetch
Length of output: 43
🏁 Script executed:
# Check if there are any Patch references or definitions in the entire docs
rg 'Patch' doc/vendoring.rst -n | head -20Repository: dfetch-org/dfetch
Length of output: 216
🏁 Script executed:
# Search for all label definitions (.. _label:) in the doc directory
rg '\.\.\s+_' doc/ | grep -i patchRepository: dfetch-org/dfetch
Length of output: 209
🏁 Script executed:
# Search for "patch" related sections/labels (case-insensitive)
rg -i '\.\.\s+_.*patch' doc/Repository: dfetch-org/dfetch
Length of output: 209
🏁 Script executed:
# Check the manifest documentation structure to understand where patch attribute is documented
rg -i 'patch.*attribute|attribute.*patch' doc/ -B 3 -A 3Repository: dfetch-org/dfetch
Length of output: 50374
🏁 Script executed:
# List all cross-reference labels in doc/vendoring.rst to see the pattern
rg '\.\.\s+_[A-Z]' doc/vendoring.rstRepository: dfetch-org/dfetch
Length of output: 43
Fix the unresolved Patch reference.
The :ref:\Patch`cross-reference at line 333 has no matching target in the documentation. This will cause Sphinx to emit a warning and fail the docs build if warnings are treated as errors. Either point it at the actual section where the patch attribute/workflow is documented, or add an explicit.. _Patch:` label.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/vendoring.rst` around lines 332 - 334, The Sphinx cross-reference
:ref:`Patch` in the text is unresolved; fix it by either adding an explicit
label for the patch section (e.g. add a section anchor like ``.. _Patch:``
immediately before the documentation section that describes the patch
attribute/workflow) or by changing the reference to point to the correct
existing label (replace ``:ref:`Patch``` with ``:ref:`<existing-label>` where
<existing-label> is the actual target for the patch attribute/workflow); ensure
the label you add or reference matches the unique identifier used elsewhere and
keep the surrounding text referencing ``dfetch diff`` and the ``Check`` CI check
unchanged.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| - doc/_ext/patches/001-autoformat-sphinxcontrib.asciinema.patch | ||
| - doc/_ext/patches/002-fix-options-sphinxcontrib.asciinema.patch | ||
|
|
||
| - name: inter-font |
Check warning
Code scanning / DFetch
Project was locally changed Warning
| - Inter*Italic* | ||
| - Inter-Black* | ||
|
|
||
| - name: jetbrains-mono-font |
Check warning
Code scanning / DFetch
Project was locally changed Warning
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
doc/static/css/custom.css (3)
327-331:⚠️ Potential issue | 🟡 Minor
border-colorshorthand overridesborder-top-color.The
border-colorshorthand on line 330 sets all four borders, overriding theborder-top-coloron line 329. Swap the order so the top border retains its intended contrast.Fix
.sd-bg-dark { background: linear-gradient(150deg, `#1e1610` 0%, `#2d2018` 100%) !important; - border-top-color: rgba(255, 255, 255, 0.12) !important; border-color: rgba(255, 255, 255, 0.07) !important; + border-top-color: rgba(255, 255, 255, 0.12) !important; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@doc/static/css/custom.css` around lines 327 - 331, In .sd-bg-dark the border-color shorthand overrides the earlier border-top-color; to preserve the intended top-border contrast, declare border-color: rgba(255, 255, 255, 0.07) !important; before declaring border-top-color: rgba(255, 255, 255, 0.12) !important; (keep the existing !important flags) so the specific border-top-color in the .sd-bg-dark rule takes precedence.
640-644:⚠️ Potential issue | 🟡 Minor
--shad-xlis undefined; cheatsheet card renders without shadow.
:rootdefines--shad-sm,--shad-md, and--shad-lg(lines 34-36), but--shad-xlis never defined. Without a fallback, thebox-shadowdeclaration is dropped entirely.Fix — use existing token or define --shad-xl
Option A: Use an existing shadow:
.cheatsheet { background: linear-gradient(150deg, `#1c1410` 0%, `#281a0f` 100%); border-radius: var(--r-lg); - box-shadow: var(--shad-xl); + box-shadow: var(--shad-lg);Option B: Define
--shad-xlin:root:--shad-lg: 0 10px 15px -3px rgba(0,0,0,.10), 0 4px 6px -4px rgba(0,0,0,.10); + --shad-xl: 0 20px 25px -5px rgba(0,0,0,.10), 0 8px 10px -6px rgba(0,0,0,.10); --r: 12px;🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@doc/static/css/custom.css` around lines 640 - 644, The .cheatsheet rule references an undefined CSS custom property --shad-xl causing the box-shadow to be dropped; fix by either replacing --shad-xl with an existing token (e.g., --shad-lg) in the .cheatsheet selector or add a new --shad-xl definition inside :root (matching the project's shadow scale) so the box-shadow declaration resolves correctly. Ensure you update either the .cheatsheet rule or the :root block accordingly and run a quick style check to confirm the shadow renders.
143-148:⚠️ Potential issue | 🟡 MinorLong code samples may be clipped on narrow viewports.
div.highlightusesoverflow: hidden !important, which clips content instead of allowing horizontal scroll. This prevents readers from seeing full commands and YAML blocks on narrower screens.Suggested fix
div.highlight { border-radius: var(--r-sm) !important; - overflow: hidden !important; + overflow-x: auto !important; + overflow-y: hidden !important; box-shadow: var(--shad-sm) !important; border: 1px solid var(--border) !important; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@doc/static/css/custom.css` around lines 143 - 148, The CSS for div.highlight currently uses overflow: hidden !important which clips long code samples; change this to allow horizontal scrolling by replacing that rule with overflow-x: auto !important (and optionally overflow-y: visible or hidden as desired) so long lines and YAML blocks can be scrolled on narrow viewports; update the div.highlight rule in doc/static/css/custom.css to use overflow-x: auto !important instead of overflow: hidden !important.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@doc/howto/check-ci.rst`:
- Around line 153-157: The GitHub Action reference in the Dfetch SARIF Check
block uses a moving branch "uses: dfetch-org/dfetch@main"; change this to an
immutable release tag or commit SHA (for example replace with "uses:
dfetch-org/dfetch@v0.12.1" or a full commit SHA) so the example is reproducible
and supply-chain safe, and update the surrounding wording if necessary to
recommend pinning to tags/SHAs rather than branches.
In `@doc/howto/sbom.rst`:
- Line 4: Replace the title "Generate a SBoM" with the standardized
capitalization "Generate an SBOM" to match industry convention and other docs;
update the heading text in the doc (the line containing "Generate a SBoM") so it
reads "Generate an SBOM".
In `@doc/reference/cli_cheatsheet.rst`:
- Around line 177-183: The current click handler attached via
btn.addEventListener uses (document.exitFullscreen ||
document.webkitExitFullscreen).call(document) and (cs.requestFullscreen ||
cs.webkitRequestFullscreen).call(cs) without verifying the chosen function
exists, which can throw if both are undefined; update the handler around the
isFull() branch to first resolve the fullscreen function (e.g., choose
document.exitFullscreen || document.webkitExitFullscreen and
cs.requestFullscreen || cs.webkitRequestFullscreen), check that the resolved
function is truthy before calling it (or use safe optional chaining), and fall
back to a no-op or an informative console.warn if no fullscreen API is
available; locate this logic in the click callback that references isFull(),
document.exitFullscreen, document.webkitExitFullscreen, cs.requestFullscreen,
and cs.webkitRequestFullscreen.
---
Duplicate comments:
In `@doc/static/css/custom.css`:
- Around line 327-331: In .sd-bg-dark the border-color shorthand overrides the
earlier border-top-color; to preserve the intended top-border contrast, declare
border-color: rgba(255, 255, 255, 0.07) !important; before declaring
border-top-color: rgba(255, 255, 255, 0.12) !important; (keep the existing
!important flags) so the specific border-top-color in the .sd-bg-dark rule takes
precedence.
- Around line 640-644: The .cheatsheet rule references an undefined CSS custom
property --shad-xl causing the box-shadow to be dropped; fix by either replacing
--shad-xl with an existing token (e.g., --shad-lg) in the .cheatsheet selector
or add a new --shad-xl definition inside :root (matching the project's shadow
scale) so the box-shadow declaration resolves correctly. Ensure you update
either the .cheatsheet rule or the :root block accordingly and run a quick style
check to confirm the shadow renders.
- Around line 143-148: The CSS for div.highlight currently uses overflow: hidden
!important which clips long code samples; change this to allow horizontal
scrolling by replacing that rule with overflow-x: auto !important (and
optionally overflow-y: visible or hidden as desired) so long lines and YAML
blocks can be scrolled on narrow viewports; update the div.highlight rule in
doc/static/css/custom.css to use overflow-x: auto !important instead of
overflow: hidden !important.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: fa8c02aa-042b-40e6-bc83-537dff135c0e
⛔ Files ignored due to path filters (10)
doc/static/fonts/inter/Inter-Bold.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-ExtraBold.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-ExtraLight.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-Light.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-Medium.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-Regular.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-SemiBold.woff2is excluded by!**/*.woff2doc/static/fonts/inter/Inter-Thin.woff2is excluded by!**/*.woff2doc/static/fonts/jetbrains-mono/JetBrainsMono-Medium.woff2is excluded by!**/*.woff2doc/static/fonts/jetbrains-mono/JetBrainsMono-Regular.woff2is excluded by!**/*.woff2
📒 Files selected for processing (33)
README.mddfetch.yamldfetch/commands/add.pydfetch/commands/import_.pydfetch/commands/update.pydoc/_ext/scenario_directive.pydoc/conf.pydoc/explanation/alternatives.rstdoc/explanation/internal.rstdoc/explanation/vendoring.rstdoc/howto/adding-a-project.rstdoc/howto/check-ci.rstdoc/howto/contributing.rstdoc/howto/migration.rstdoc/howto/patching.rstdoc/howto/sbom.rstdoc/howto/troubleshooting.rstdoc/howto/updating-projects.rstdoc/index.rstdoc/landing-page/index.rstdoc/reference/changelog.rstdoc/reference/cli_cheatsheet.rstdoc/reference/commands.rstdoc/reference/legal.rstdoc/reference/manifest.rstdoc/static/css/custom.cssdoc/static/fonts/inter/.dfetch_data.yamldoc/static/fonts/inter/LICENSE.txtdoc/static/fonts/jetbrains-mono/.dfetch_data.yamldoc/static/js/diataxis.jsdoc/tutorials/getting_started.rstdoc/tutorials/installation.rstfeatures/add-project-through-cli.feature
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@doc/howto/sbom.rst`:
- Around line 18-20: The doc claim that licenses are stored in
``.dfetch_data.yaml`` is incorrect; update the text to explain that license data
is not persisted by Metadata.dump and instead is discovered at report time by
_determine_licenses which scans the fetched project directory, so SBOM/license
entries only appear if the project has been fetched and its source tree is
present during report generation. Mention the actual metadata file name
(``.dfetch_data.yaml``) and the two functions (_determine_licenses and
Metadata.dump) so readers know where the behavior originates and that missing
fetched directories yield empty license lists.
- Around line 23-25: The docs incorrectly state only SHA-256 is included; update
doc/howto/sbom.rst so the text mentions all supported algorithms (SHA-256,
SHA-384, and SHA-512) instead of just "SHA-256". Reference the actual supported
set by aligning the wording with the code mappings (DFETCH_TO_CDX_HASH_ALGORITHM
in sbom_reporter.py and SUPPORTED_HASH_ALGORITHMS in integrity_hash.py) and
adjust the phrasing around the ``integrity.hash:`` field to list these three
algorithms for component hash/supply-chain integrity verification.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 389f7d52-150e-4c73-a2b4-5fe6ceaeb21e
📒 Files selected for processing (1)
doc/howto/sbom.rst
Comment on lines
+18
to
+20
| *Dfetch* parses each project's license at fetch time and stores it in the | ||
| ``.dfetch_data.yaml`` metadata file, so reports stay accurate without | ||
| re-fetching. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify that Metadata class does not persist license information
# Check Metadata class definition and dump method
rg -n -A 10 'def dump\(self\)' dfetch/project/metadata.py
# Check if license field exists anywhere in metadata handling
rg -n '\blicense' dfetch/project/metadata.py
# Verify _determine_licenses scans directory, not metadata
rg -n -B 3 -A 10 'def _determine_licenses' dfetch/commands/report.pyRepository: dfetch-org/dfetch
Length of output: 1273
Documentation incorrectly describes license persistence.
The documentation claims licenses are "stored in the .dfetch_data.yaml metadata file," but verification confirms this is false:
-
Metadata.dump()(metadata.py:184-203) persists only:remote_url,branch,revision,last_fetch,tag,hash,patch, anddependencies— no license field. -
_determine_licenses()(report.py:103+) scans the fetched project directory at report-generation time, not from metadata. If never fetched, it returns an empty list.
SBOM generation requires the fetched source code to be present; reports will be incomplete if project directories are unavailable.
Suggested fix:
*Dfetch* auto-detects each project's license by scanning the fetched source
directory during report generation. The project must be fetched for license
information to appear in the SBOM.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/howto/sbom.rst` around lines 18 - 20, The doc claim that licenses are
stored in ``.dfetch_data.yaml`` is incorrect; update the text to explain that
license data is not persisted by Metadata.dump and instead is discovered at
report time by _determine_licenses which scans the fetched project directory, so
SBOM/license entries only appear if the project has been fetched and its source
tree is present during report generation. Mention the actual metadata file name
(``.dfetch_data.yaml``) and the two functions (_determine_licenses and
Metadata.dump) so readers know where the behavior originates and that missing
fetched directories yield empty license lists.
Comment on lines
+23
to
+25
| ``distribution`` external reference. When an ``integrity.hash:`` field is set | ||
| in the manifest the SBOM includes a ``SHA-256`` component hash for | ||
| supply-chain integrity verification. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify which hash algorithms are supported for integrity hashes
# Find the DFETCH_TO_CDX_HASH_ALGORITHM mapping
rg -n -B 2 -A 10 'DFETCH_TO_CDX_HASH_ALGORITHM' dfetch/reporting/sbom_reporter.py
# Check IntegrityHash implementation for supported algorithms
rg -n -B 3 -A 10 'class IntegrityHash' dfetch/Repository: dfetch-org/dfetch
Length of output: 1897
Update documentation to reflect all supported hash algorithms.
The documentation states the SBOM includes a SHA-256 component hash, but the code supports multiple hash algorithms. The DFETCH_TO_CDX_HASH_ALGORITHM mapping (sbom_reporter.py:128-132) and SUPPORTED_HASH_ALGORITHMS in integrity_hash.py both confirm support for SHA-256, SHA-384, and SHA-512.
Suggested fix
-Archive dependencies (``tar.gz``, ``zip``, …) are recorded with a
-``distribution`` external reference. When an ``integrity.hash:`` field is set
-in the manifest the SBOM includes a ``SHA-256`` component hash for
-supply-chain integrity verification.
+Archive dependencies (``tar.gz``, ``zip``, …) are recorded with a
+``distribution`` external reference. When an ``integrity.hash:`` field is set
+in the manifest the SBOM includes a component hash (SHA-256, SHA-384, or
+SHA-512) for supply-chain integrity verification.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc/howto/sbom.rst` around lines 23 - 25, The docs incorrectly state only
SHA-256 is included; update doc/howto/sbom.rst so the text mentions all
supported algorithms (SHA-256, SHA-384, and SHA-512) instead of just "SHA-256".
Reference the actual supported set by aligning the wording with the code
mappings (DFETCH_TO_CDX_HASH_ALGORITHM in sbom_reporter.py and
SUPPORTED_HASH_ALGORITHMS in integrity_hash.py) and adjust the phrasing around
the ``integrity.hash:`` field to list these three algorithms for component
hash/supply-chain integrity verification.
Contributor
Author
|
@coderabbitai fix both issues as suggested and push to this branch |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chainI need to look up what specific issues were flagged in the PR review before I can plan the fixes. 🏁 Script executed: Length of output: 60645 Let me read the relevant files to plan the fixes. 🏁 Script executed: Length of output: 2628 🏁 Script executed: Length of output: 1587 🏁 Script executed: Length of output: 335 🏁 Script executed: Length of output: 15985 I've confirmed both issues. Here are the exact fixes needed for
Failed to handle agent chat message. Please try again. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR comprehensively redesigns the documentation's visual appearance and reorganizes the manual to follow the Diataxis framework. The changes include a complete CSS overhaul with a modern design system, improved typography, and better visual hierarchy across all documentation pages.
Key Changes
Design System & Styling (
doc/static/css/custom.css).band-tint,.band-mint) for visual emphasisDocumentation Structure (
doc/manual.rst)commands.puml): Visual mind map of command hierarchyFeature Documentation
features/interactive-add.featurefile--interactiveflag is separate from basic CLI optionsSupporting Files
doc/contributing.rst): Added comprehensive design token documentation with color swatches and typography samplesdoc/static/js/diataxis.js): New JavaScript module for automatic page classification and sidebar coloringcheck.pumlandupdate.pumlwith consistent stylingdoc/conf.py): Addedsphinx_designextension and diataxis.js scriptNotable Implementation Details
:root) for easy theming and consistencycalc()and viewport-relative widths for responsive edge-to-edge backgroundshttps://claude.ai/code/session_0183Tzu6McYvSDwoXDoRjEyN
Summary by CodeRabbit