Skip to content

docs: Improve devcontainer and CLI configuration documentation#1854

Merged
aknysh merged 2 commits intomainfrom
osterman/devcontainer-docs-card
Dec 10, 2025
Merged

docs: Improve devcontainer and CLI configuration documentation#1854
aknysh merged 2 commits intomainfrom
osterman/devcontainer-docs-card

Conversation

@osterman
Copy link
Copy Markdown
Member

@osterman osterman commented Dec 10, 2025

What

  • Added ActionCard component to devcontainer commands page linking to configuration reference for improved discoverability
  • Removed explicit sidebar_position values from 18 CLI Configuration docs to enable automatic alphabetical sorting
  • Fixed How-To Guides sidebar labels to use Title Case (Catalogs, Inheritance, Mixins) for consistency
  • Updated minimum Atmos version requirement to v1.201.0 in Geodesic guide
  • Converted blockquote note to Docusaurus admonition format in using-geodesic.mdx

Why

  • ActionCard provides consistent navigation pattern across all command documentation
  • Alphabetical sidebar sorting improves discoverability and eliminates manual position management
  • Title Case labels align with documentation style guidelines
  • Version bump reflects latest feature requirements

References

  • Docusaurus ActionCard pattern follows atmos.tools/cli/commands/auth/, terraform/, validate/ and other command pages

Summary by CodeRabbit

  • New Features

    • Added a configuration guide card to devcontainer documentation with direct access to the configuration reference.
  • Documentation

    • Updated minimum version requirement for devcontainer feature to v1.201.0.
    • Reorganized documentation navigation structure and improved sidebar label capitalization for consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@osterman osterman requested a review from a team as a code owner December 10, 2025 14:49
@github-actions github-actions bot added the size/s Small size PR label Dec 10, 2025
@osterman osterman added the no-release Do not create a new release (wait for additional code changes) label Dec 10, 2025
@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 10, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

… labels

- Add ActionCard component to devcontainer commands page linking to configuration reference
- Remove sidebar_position from 18 CLI Configuration docs to enable alphabetical sorting by filename
- Change How-To Guides sidebar labels from lowercase (catalogs, inheritance, mixins) to Title Case
- Update minimum Atmos version requirement from v1.200.0 to v1.201.0 in Geodesic guide
- Convert blockquote note to Docusaurus admonition in using-geodesic.mdx

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 10, 2025

📝 Walkthrough

Walkthrough

This PR updates documentation metadata and structure across the CLI and howto guides. Changes include removing sidebar_position metadata from configuration docs (likely delegating ordering to a configuration system), capitalizing sidebar labels for consistency, adding an ActionCard component to the devcontainer command docs, and updating minimum version requirements with improved formatting.

Changes

Cohort / File(s) Summary
Remove sidebar_position from CLI configuration docs
website/docs/cli/configuration/aliases.mdx, commands.mdx, describe.mdx, devcontainer.mdx, docs.mdx, errors.mdx, imports.mdx, integrations.mdx, logs.mdx, metadata.mdx, profiler.mdx, profiles.mdx, schemas.mdx, stores.mdx, templates.mdx, validate.mdx, vendor.mdx, workflows.mdx
Removed sidebar_position frontmatter entries across 18 configuration documentation files. validate.mdx and vendor.mdx also added description fields.
Capitalize sidebar labels in howto guides
website/docs/howto/catalogs.mdx, inheritance.mdx, mixins.mdx
Updated sidebar_label from lowercase to title case (e.g., "catalogs" → "Catalogs").
Enhance devcontainer command documentation
website/docs/cli/commands/devcontainer/devcontainer.mdx
Added ActionCard component with PrimaryCTA button linking to configuration reference, positioned before the existing Screengrab component.
Update geodesic guide with version bump
website/docs/howto/using-geodesic.mdx
Replaced bold Note text with formal admonition block and updated minimum Atmos version requirement from v1.200.0 to v1.201.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • The majority of changes are repetitive removal of sidebar_position metadata across configuration files
  • The devcontainer component addition (ActionCard and PrimaryCTA) merits brief review to confirm proper imports and placement
  • Capitalization changes and version updates are straightforward

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main focus of the PR: improving documentation for devcontainer and CLI configuration across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch osterman/devcontainer-docs-card

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0a2c722 and 93c371b.

📒 Files selected for processing (23)
  • website/docs/cli/commands/devcontainer/devcontainer.mdx (1 hunks)
  • website/docs/cli/configuration/aliases.mdx (0 hunks)
  • website/docs/cli/configuration/commands.mdx (0 hunks)
  • website/docs/cli/configuration/describe.mdx (0 hunks)
  • website/docs/cli/configuration/devcontainer.mdx (0 hunks)
  • website/docs/cli/configuration/docs.mdx (0 hunks)
  • website/docs/cli/configuration/errors.mdx (0 hunks)
  • website/docs/cli/configuration/imports.mdx (0 hunks)
  • website/docs/cli/configuration/integrations.mdx (0 hunks)
  • website/docs/cli/configuration/logs.mdx (0 hunks)
  • website/docs/cli/configuration/metadata.mdx (0 hunks)
  • website/docs/cli/configuration/profiler.mdx (0 hunks)
  • website/docs/cli/configuration/profiles.mdx (0 hunks)
  • website/docs/cli/configuration/schemas.mdx (0 hunks)
  • website/docs/cli/configuration/stores.mdx (0 hunks)
  • website/docs/cli/configuration/templates.mdx (0 hunks)
  • website/docs/cli/configuration/validate.mdx (0 hunks)
  • website/docs/cli/configuration/vendor.mdx (0 hunks)
  • website/docs/cli/configuration/workflows.mdx (0 hunks)
  • website/docs/howto/catalogs.mdx (1 hunks)
  • website/docs/howto/inheritance.mdx (1 hunks)
  • website/docs/howto/mixins.mdx (1 hunks)
  • website/docs/howto/using-geodesic.mdx (1 hunks)
💤 Files with no reviewable changes (18)
  • website/docs/cli/configuration/metadata.mdx
  • website/docs/cli/configuration/logs.mdx
  • website/docs/cli/configuration/schemas.mdx
  • website/docs/cli/configuration/workflows.mdx
  • website/docs/cli/configuration/devcontainer.mdx
  • website/docs/cli/configuration/stores.mdx
  • website/docs/cli/configuration/profiles.mdx
  • website/docs/cli/configuration/aliases.mdx
  • website/docs/cli/configuration/integrations.mdx
  • website/docs/cli/configuration/commands.mdx
  • website/docs/cli/configuration/vendor.mdx
  • website/docs/cli/configuration/describe.mdx
  • website/docs/cli/configuration/errors.mdx
  • website/docs/cli/configuration/validate.mdx
  • website/docs/cli/configuration/docs.mdx
  • website/docs/cli/configuration/imports.mdx
  • website/docs/cli/configuration/templates.mdx
  • website/docs/cli/configuration/profiler.mdx
🧰 Additional context used
📓 Path-based instructions (2)
website/**

📄 CodeRabbit inference engine (.cursor/rules/atmos-rules.mdc)

website/**: Update website documentation in the website/ directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
Keep website code in the website/ directory, follow the existing website architecture and style, and test website changes locally before committing
Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases

Files:

  • website/docs/howto/mixins.mdx
  • website/docs/cli/commands/devcontainer/devcontainer.mdx
  • website/docs/howto/inheritance.mdx
  • website/docs/howto/catalogs.mdx
  • website/docs/howto/using-geodesic.mdx
website/docs/cli/commands/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

All CLI commands need Docusaurus documentation using <dl> for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: website/docs/cli/commands/<command>/<subcommand>.mdx. Always build after changes: cd website && npm run build

Files:

  • website/docs/cli/commands/devcontainer/devcontainer.mdx
🧠 Learnings (11)
📓 Common learnings
Learnt from: Listener430
Repo: cloudposse/atmos PR: 934
File: tests/fixtures/scenarios/docs-generate/README.md.gotmpl:99-118
Timestamp: 2025-01-25T03:51:57.689Z
Learning: For the cloudposse/atmos repository, changes to template contents should be handled in dedicated PRs and are typically considered out of scope for PRs focused on other objectives.
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 955
File: tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden:0-0
Timestamp: 2025-01-19T15:49:15.593Z
Learning: In future commits, the help text for Atmos CLI commands should be limited to only show component and stack parameters for commands that actually use them. This applies to the example usage section in command help text.
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: .cursor/rules/atmos-rules.mdc:0-0
Timestamp: 2025-11-24T17:35:37.209Z
Learning: Applies to website/** : Update website documentation in the `website/` directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T19:24:49.343Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI commands need Docusaurus documentation using `<dl>` for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: `website/docs/cli/commands/<command>/<subcommand>.mdx`. Always build after changes: `cd website && npm run build`
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: .cursor/rules/atmos-rules.mdc:0-0
Timestamp: 2025-11-24T17:35:37.209Z
Learning: Applies to website/** : Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T19:24:49.343Z
Learning: Applies to docs/prd/*.md : Use kebab-case for PRD filenames: `command-registry-pattern.md`, `error-handling-strategy.md`, `testing-strategy.md`. All PRDs in `docs/prd/`
📚 Learning: 2025-12-06T19:24:49.343Z
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T19:24:49.343Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI commands need Docusaurus documentation using `<dl>` for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: `website/docs/cli/commands/<command>/<subcommand>.mdx`. Always build after changes: `cd website && npm run build`

Applied to files:

  • website/docs/cli/commands/devcontainer/devcontainer.mdx
📚 Learning: 2025-09-13T16:39:20.007Z
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-11-01T20:24:29.557Z
Learnt from: osterman
Repo: cloudposse/atmos PR: 1714
File: NOTICE:0-0
Timestamp: 2025-11-01T20:24:29.557Z
Learning: In the cloudposse/atmos repository, the NOTICE file is programmatically generated and should not be manually edited. Issues with dependency license URLs in NOTICE will be resolved when upstream package metadata is corrected.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-09-10T21:17:55.273Z
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: toolchain/http_client_test.go:3-10
Timestamp: 2025-09-10T21:17:55.273Z
Learning: In the cloudposse/atmos repository, imports should never be changed as per samtholiya's coding guidelines.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-09-08T01:25:44.958Z
Learnt from: osterman
Repo: cloudposse/atmos PR: 1466
File: website/docs/cli/commands/toolchain/usage.mdx:117-121
Timestamp: 2025-09-08T01:25:44.958Z
Learning: The atmos toolchain has been updated to follow XDG Base Directory Specification with helper functions GetXDGCacheDir() and GetXDGTempCacheDir() in toolchain/xdg_cache.go, using XDG_CACHE_HOME when set and falling back to ~/.cache/atmos-toolchain, making it consistent with atmos core's XDG compliance.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2024-11-12T03:15:15.627Z
Learnt from: aknysh
Repo: cloudposse/atmos PR: 775
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-12T03:15:15.627Z
Learning: It is acceptable to set `ARG ATMOS_VERSION` to a future version like `1.105.0` in `examples/quick-start-advanced/Dockerfile` if that will be the next release.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-02-18T13:13:11.497Z
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1068
File: tests/snapshots/TestCLICommands_atmos_terraform_help.stdout.golden:59-64
Timestamp: 2025-02-18T13:13:11.497Z
Learning: For Atmos CLI help text, angle brackets in command examples and flag descriptions should be escaped using HTML entities (e.g., `&lt;component&gt;`) rather than converted to backticks or other markdown formatting.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-03-18T12:26:25.329Z
Learnt from: Listener430
Repo: cloudposse/atmos PR: 1149
File: tests/snapshots/TestCLICommands_atmos_vendor_pull_ssh.stderr.golden:7-7
Timestamp: 2025-03-18T12:26:25.329Z
Learning: In the Atmos project, typos or inconsistencies in test snapshot files (such as "terrafrom" instead of "terraform") may be intentional as they capture the exact output of commands and should not be flagged as issues requiring correction.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2024-10-27T16:59:26.187Z
Learnt from: osterman
Repo: cloudposse/atmos PR: 729
File: internal/exec/help.go:48-51
Timestamp: 2024-10-27T16:59:26.187Z
Learning: In the Atmos CLI help messages, when providing examples that include the version number, use the actual version variable (e.g., `version.Version`) instead of placeholders like `<version>`.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2024-11-23T00:13:22.004Z
Learnt from: osterman
Repo: cloudposse/atmos PR: 801
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-23T00:13:22.004Z
Learning: When updating the `ATMOS_VERSION` in Dockerfiles, the team prefers to pin to the next future version when the PR merges, even if the version is not yet released.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Summary
🔇 Additional comments (7)
website/docs/howto/mixins.mdx (1)

4-4: Sidebar label capitalization aligns with style guidelines.

Changing to Title Case improves consistency across how-to documentation.

website/docs/howto/inheritance.mdx (1)

4-4: Sidebar label capitalization aligns with style guidelines.

Changing to Title Case improves consistency across how-to documentation.

website/docs/howto/catalogs.mdx (1)

4-4: Sidebar label capitalization aligns with style guidelines.

Changing to Title Case improves consistency across how-to documentation.

website/docs/cli/commands/devcontainer/devcontainer.mdx (2)

13-14: ActionCard and PrimaryCTA imports correctly positioned.

Imports follow the established component pattern.


22-27: ActionCard component improves navigation discoverability.

Well-structured with clear CTA linking to the configuration reference. Placement before Screengrab provides good content flow.

Verify that the link target /cli/configuration/devcontainer exists in your documentation structure and the ActionCard/PrimaryCTA components are properly exported from @site/src/components/.

website/docs/howto/using-geodesic.mdx (2)

9-11: Admonition formatting improves semantic clarity.

Converting from inline bold to proper :::note admonition follows Docusaurus best practices and improves visual hierarchy.


10-10: Verify minimum version requirement v1.201.0 is accurate.

The version bump aligns with PR objectives. Ensure this reflects the actual minimum Atmos version that includes the atmos devcontainer feature set documented here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Dec 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.12%. Comparing base (0a2c722) to head (93c371b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1854      +/-   ##
==========================================
+ Coverage   73.08%   73.12%   +0.04%     
==========================================
  Files         550      550              
  Lines       53168    53168              
==========================================
+ Hits        38859    38881      +22     
+ Misses      11453    11432      -21     
+ Partials     2856     2855       -1     
Flag Coverage Δ
unittests 73.12% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 10, 2025

📝 Walkthrough

Walkthrough

This PR updates documentation by removing sidebar_position metadata from approximately 18 CLI configuration files, adds UI components (ActionCard and PrimaryCTA) to the devcontainer command page, capitalizes sidebar labels in three howto pages, and updates the minimum Atmos version from v1.200.0 to v1.201.0 with formatting adjustments.

Changes

Cohort / File(s) Summary
CLI Configuration Sidebar Position Removal
website/docs/cli/configuration/{aliases, commands, describe, devcontainer, docs, errors, imports, integrations, logs, metadata, profiler, schemas, stores, templates, validate, vendor, workflows}.mdx
Removed sidebar_position frontmatter field from all files. Metadata-only changes affecting documentation navigation ordering.
CLI Configuration Additional Adjustments
website/docs/cli/configuration/profiles.mdx
Fixed YAML frontmatter indentation of sidebar_position key from mis-aligned to top-level alignment.
Devcontainer Command Enhancement
website/docs/cli/commands/devcontainer/devcontainer.mdx
Added ActionCard and PrimaryCTA imports; injected new ActionCard block titled "Configure Devcontainers" with descriptive text and link to configuration reference.
Howto Sidebar Label Capitalization
website/docs/howto/{catalogs, inheritance, mixins}.mdx
Updated sidebar_label frontmatter from lowercase (e.g., "catalogs") to title case (e.g., "Catalogs").
Howto Getting Started Updates
website/docs/howto/using-geodesic.mdx
Updated minimum Atmos version from v1.200.0 to v1.201.0; replaced bold note with formal admonition block (:::note ... :::).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Most changes are repetitive frontmatter removals across configuration files—low cognitive overhead per file
  • ActionCard addition is straightforward content injection with no logic complexity
  • Consider spot-checking the ActionCard placement in devcontainer.mdx for proper integration with surrounding content
  • Verify that removal of sidebar_position across all files doesn't inadvertently affect documentation site sidebar ordering or navigation

Possibly related PRs

Suggested reviewers

  • aknysh
  • milldr

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly reflects the main changes: improvements to devcontainer documentation (ActionCard addition) and CLI configuration documentation (sidebar sorting, label capitalization).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch osterman/devcontainer-docs-card

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0a2c722 and 93c371b.

📒 Files selected for processing (23)
  • website/docs/cli/commands/devcontainer/devcontainer.mdx (1 hunks)
  • website/docs/cli/configuration/aliases.mdx (0 hunks)
  • website/docs/cli/configuration/commands.mdx (0 hunks)
  • website/docs/cli/configuration/describe.mdx (0 hunks)
  • website/docs/cli/configuration/devcontainer.mdx (0 hunks)
  • website/docs/cli/configuration/docs.mdx (0 hunks)
  • website/docs/cli/configuration/errors.mdx (0 hunks)
  • website/docs/cli/configuration/imports.mdx (0 hunks)
  • website/docs/cli/configuration/integrations.mdx (0 hunks)
  • website/docs/cli/configuration/logs.mdx (0 hunks)
  • website/docs/cli/configuration/metadata.mdx (0 hunks)
  • website/docs/cli/configuration/profiler.mdx (0 hunks)
  • website/docs/cli/configuration/profiles.mdx (0 hunks)
  • website/docs/cli/configuration/schemas.mdx (0 hunks)
  • website/docs/cli/configuration/stores.mdx (0 hunks)
  • website/docs/cli/configuration/templates.mdx (0 hunks)
  • website/docs/cli/configuration/validate.mdx (0 hunks)
  • website/docs/cli/configuration/vendor.mdx (0 hunks)
  • website/docs/cli/configuration/workflows.mdx (0 hunks)
  • website/docs/howto/catalogs.mdx (1 hunks)
  • website/docs/howto/inheritance.mdx (1 hunks)
  • website/docs/howto/mixins.mdx (1 hunks)
  • website/docs/howto/using-geodesic.mdx (1 hunks)
💤 Files with no reviewable changes (18)
  • website/docs/cli/configuration/commands.mdx
  • website/docs/cli/configuration/errors.mdx
  • website/docs/cli/configuration/devcontainer.mdx
  • website/docs/cli/configuration/docs.mdx
  • website/docs/cli/configuration/stores.mdx
  • website/docs/cli/configuration/templates.mdx
  • website/docs/cli/configuration/logs.mdx
  • website/docs/cli/configuration/metadata.mdx
  • website/docs/cli/configuration/integrations.mdx
  • website/docs/cli/configuration/describe.mdx
  • website/docs/cli/configuration/imports.mdx
  • website/docs/cli/configuration/vendor.mdx
  • website/docs/cli/configuration/schemas.mdx
  • website/docs/cli/configuration/profiler.mdx
  • website/docs/cli/configuration/workflows.mdx
  • website/docs/cli/configuration/validate.mdx
  • website/docs/cli/configuration/aliases.mdx
  • website/docs/cli/configuration/profiles.mdx
🧰 Additional context used
📓 Path-based instructions (2)
website/**

📄 CodeRabbit inference engine (.cursor/rules/atmos-rules.mdc)

website/**: Update website documentation in the website/ directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
Keep website code in the website/ directory, follow the existing website architecture and style, and test website changes locally before committing
Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases

Files:

  • website/docs/howto/inheritance.mdx
  • website/docs/howto/catalogs.mdx
  • website/docs/cli/commands/devcontainer/devcontainer.mdx
  • website/docs/howto/using-geodesic.mdx
  • website/docs/howto/mixins.mdx
website/docs/cli/commands/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

All CLI commands need Docusaurus documentation using <dl> for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: website/docs/cli/commands/<command>/<subcommand>.mdx. Always build after changes: cd website && npm run build

Files:

  • website/docs/cli/commands/devcontainer/devcontainer.mdx
🧠 Learnings (5)
📓 Common learnings
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.
Learnt from: Listener430
Repo: cloudposse/atmos PR: 934
File: tests/fixtures/scenarios/docs-generate/README.md.gotmpl:99-118
Timestamp: 2025-01-25T03:51:57.689Z
Learning: For the cloudposse/atmos repository, changes to template contents should be handled in dedicated PRs and are typically considered out of scope for PRs focused on other objectives.
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T19:24:49.343Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI commands need Docusaurus documentation using `<dl>` for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: `website/docs/cli/commands/<command>/<subcommand>.mdx`. Always build after changes: `cd website && npm run build`
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 955
File: tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden:0-0
Timestamp: 2025-01-19T15:49:15.593Z
Learning: In future commits, the help text for Atmos CLI commands should be limited to only show component and stack parameters for commands that actually use them. This applies to the example usage section in command help text.
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: .cursor/rules/atmos-rules.mdc:0-0
Timestamp: 2025-11-24T17:35:37.209Z
Learning: Applies to website/** : Update website documentation in the `website/` directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
📚 Learning: 2025-12-06T19:24:49.343Z
Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-06T19:24:49.343Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI commands need Docusaurus documentation using `<dl>` for arguments/flags. Follow Docusaurus conventions: frontmatter (slug, title, etc.), purpose note, screengrab, usage/examples/arguments/flags sections. File location: `website/docs/cli/commands/<command>/<subcommand>.mdx`. Always build after changes: `cd website && npm run build`

Applied to files:

  • website/docs/cli/commands/devcontainer/devcontainer.mdx
📚 Learning: 2025-09-13T16:39:20.007Z
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-11-01T20:24:29.557Z
Learnt from: osterman
Repo: cloudposse/atmos PR: 1714
File: NOTICE:0-0
Timestamp: 2025-11-01T20:24:29.557Z
Learning: In the cloudposse/atmos repository, the NOTICE file is programmatically generated and should not be manually edited. Issues with dependency license URLs in NOTICE will be resolved when upstream package metadata is corrected.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
📚 Learning: 2025-09-10T21:17:55.273Z
Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: toolchain/http_client_test.go:3-10
Timestamp: 2025-09-10T21:17:55.273Z
Learning: In the cloudposse/atmos repository, imports should never be changed as per samtholiya's coding guidelines.

Applied to files:

  • website/docs/howto/using-geodesic.mdx
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Acceptance Tests (windows)
  • GitHub Check: Summary
🔇 Additional comments (8)
website/docs/howto/inheritance.mdx (1)

4-4: Sidebar label capitalization aligns with documentation style.

Title-casing sidebar labels improves navigation UX and maintains consistency across How-To guides.

website/docs/howto/using-geodesic.mdx (2)

9-11: Admonition format improves semantic structure.

Converting to Docusaurus :::note admonition is the right pattern here—better for accessibility and theming consistency.


10-10: Verify version bump is accurate and complete.

Version updated to v1.201.0. Note that line 150 in the troubleshooting section still references v1.200.0 ("Upgrade to Atmos v1.200.0 or later")—confirm whether that should also be bumped to match.

website/docs/howto/mixins.mdx (2)

4-4: Sidebar label capitalization aligns with documentation style.

Title-casing sidebar labels improves navigation UX and maintains consistency with other How-To guides (Inheritance, Catalogs).


13-14: Component imports support content enhancement.

ActionCard and PrimaryCTA imports are properly utilized in the file (lines 101–104) to guide readers to design patterns. Clean addition.

website/docs/cli/commands/devcontainer/devcontainer.mdx (2)

13-14: Component imports support discoverability enhancement.

ActionCard and PrimaryCTA are appropriately imported to create a navigational pattern consistent with other command pages.


22-27: ActionCard placement improves discoverability.

Strategic placement right after the intro section provides users with a clear path to configuration documentation. The link to /cli/configuration/devcontainer is well-positioned for the reader's journey.

website/docs/howto/catalogs.mdx (1)

4-4: Sidebar label capitalization aligns with documentation style.

Title-casing sidebar labels improves navigation UX and maintains consistency across How-To guides (Inheritance, Mixins).


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aknysh aknysh merged commit d07d554 into main Dec 10, 2025
57 checks passed
@aknysh aknysh deleted the osterman/devcontainer-docs-card branch December 10, 2025 15:58
@github-actions
Copy link
Copy Markdown

These changes were released in v1.203.0-test.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release Do not create a new release (wait for additional code changes) size/s Small size PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants