8000 Fix docs to use definition lists by osterman · Pull Request #1318 · cloudposse/atmos · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix docs to use definition lists #1318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix docs to use definition lists #1318

wants to merge 1 commit into from

Conversation

osterman
Copy link
Member
@osterman osterman commented Jun 19, 2025 •
edited by coderabbitai bot
Loading

Summary

  • convert parameter docs to use <dl> elements
  • clarify CLI docs with nested definition lists
  • fix broken frontmatter in completion docs

Testing

  • git status --short

https://chatgpt.com/codex/tasks/task_b_68546ebc7f188332a30b6269b50073e7

Summary by CodeRabbit

  • Documentation
    • Reformatted CLI command and configuration documentation to use HTML definition lists for arguments, flags, and configuration keys, improving readability and semantic structure.
    • Clarified and streamlined some descriptions for consistency without changing their meaning.
    • Enhanced output schema documentation with clearer grouping and concise explanations.
    • No changes to command functionality or configuration semantics; updates are purely presentational.

@osterman osterman requested a review from a team as a code owner June 19, 2025 22:45
@github-actions github-actions bot added the size/l Large size PR label Jun 19, 2025
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 19, 2025
📝 Walkthrough

Walkthrough

This update reformats documentation across multiple CLI command and configuration files. Markdown tables and plain text lists describing arguments, flags, and configuration keys have been replaced with HTML definition lists (<dl>, <dt>, <dd>), improving semantic structure and clarity. No changes were made to command functionality, descriptions, or configuration semantics.

Changes

Files/Paths Change Summary
website/docs/cli/commands/aws/aws-eks-update-kubeconfig.mdx,
.../completion.mdx,
.../describe/describe-component.mdx,
.../describe/describe-dependents.mdx,
.../helmfile/helmfile-generate-varfile.mdx,
.../helmfile/usage.mdx,
.../terraform/terraform-plan-diff.mdx,
.../validate/validate-component.mdx,
.../validate/validate-editorconfig.mdx,
.../validate/validate-schema.mdx,
.../validate/validate-stacks.mdx		 Reformatted documentation for arguments and flags from markdown tables to HTML definition lists. Content unchanged.
website/docs/cli/configuration/stacks.mdx Reformatted configuration key explanations from markdown lists to HTML definition lists.
website/docs/core-concepts/components/helmfile.mdx,
.../terraform/terraform.mdx,
.../projects/configuration/opentofu.mdx		 Converted plain text argument explanations to HTML definition lists for improved structure.
website/docs/tutorials/atmos-example-infra.mdx Reformatted stack and component section descriptions from lists to HTML definition lists.

Suggested labels

no-release

Suggested reviewers

  • aknysh
✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/update-markdown-lists-with-definition-lists

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.
8000

coderabbitai[bot]
coderabbitai bot reviewed Jun 19, 2025
View reviewed changes
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (2)
website/docs/cli/configuration/stacks.mdx (1)

52-230: Nested markdown lists inside <dd> may not render in MDX.
Embedding - lists inside an HTML <dd> block can prevent proper parsing. To ensure the nested examples render, convert those markdown lists to HTML <ul><li> or nested <dl> elements.

website/docs/cli/commands/describe/describe-component.mdx (1)

62-67: Inconsistent arguments formatting: still using a markdown table.
For consistency with flags and the rest of the CLI reference, convert the ## Arguments table into a <dl> block.

🧹 Nitpick comments (2)
website/docs/core-concepts/projects/configuration/opentofu.mdx (1)

158-163: Unify indentation for definition list entries
The <dt>/<dd> entries here are indented by two spaces, whereas the earlier list at lines 56–75 uses four spaces. For visual consistency, align both lists to the same indentation level.

website/docs/cli/commands/helmfile/helmfile-generate-varfile.mdx (1)

49-60: Adjust multi-line <dd> indentation
The second line in the <dd> for --file is unindented, which reduces readability. Consider wrapping the content in a block and indenting consistently:

<dl>
  <dt>`--file` (`-f`)</dt>
-  <dd>File name to write the varfile to.<br/>
-If not specified, the varfile name is generated automatically from the context</dd>
+  <dd>
+    File name to write the varfile to.<br/>
+    If not specified, the varfile name is generated automatically from the context
+  </dd>
</dl>
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 913fe03 and 2d0b116.

📒 Files selected for processing (16)
  • website/docs/cli/commands/aws/aws-eks-update-kubeconfig.mdx (1 hunks)
  • website/docs/cli/commands/completion.mdx (1 hunks)
  • website/docs/cli/commands/describe/describe-component.mdx (1 hunks)
  • website/docs/cli/commands/describe/describe-dependents.mdx (2 hunks)
  • website/docs/cli/commands/helmfile/helmfile-generate-varfile.mdx (1 hunks)
  • website/docs/cli/commands/helmfile/usage.mdx (1 hunks)
  • website/docs/cli/commands/terraform/terraform-plan-diff.mdx (2 hunks)
  • website/docs/cli/commands/validate/validate-component.mdx (1 hunks)
  • website/docs/cli/commands/validate/validate-editorconfig.mdx (1 hunks)
  • website/docs/cli/commands/validate/validate-schema.mdx (1 hunks)
  • website/docs/cli/commands/validate/validate-stacks.mdx (1 hunks)
  • website/docs/cli/configuration/stacks.mdx (4 hunks)
  • website/docs/core-concepts/components/helmfile.mdx (1 hunks)
  • website/docs/core-concepts/components/terraform/terraform.mdx (1 hunks)
  • website/docs/core-concepts/projects/configuration/opentofu.mdx (1 hunks)
  • website/docs/tutorials/atmos-example-infra.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/tutorials/atmos-example-infra.mdx

[typographical] ~161-~161: To join two clauses or introduce examples, consider using an em dash.
Context: ...a terminal: - cd example - make all - it will build the Docker image, build th...

(DASH_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (go)
  • GitHub Check: Lint (golangci)
  • GitHub Check: Summary
🔇 Additional comments (23)
website/docs/core-concepts/components/terraform/terraform.mdx (1)

157-162: Semantically correct definition list

The <dl>, <dt>, and <dd> tags are used appropriately here to replace the previous bullet list, improving semantic structure and accessibility without altering content.

website/docs/cli/commands/completion.mdx (1)

122-125: Definition list for command arguments

The new <dl> block correctly replaces the markdown table for shell_name, preserving the description and required status.

website/docs/tutorials/atmos-example-infra.mdx (2)

125-140: Definition list for stack config sections

The <dl> markup clearly and semantically outlines import, vars, terraform, helmfile, and components sections. This enhances readability and consistency.

144-154: Definition list for component types

The second <dl> block correctly describes the terraform and helmfile component configuration entries, matching the surrounding style.

website/docs/core-concepts/components/helmfile.mdx (1)

26-31: Argument definition list

The <dl> markup for nginx-ingress and --stack=ue2-dev is well-formed and aligns with the updated documentation style.

website/docs/cli/commands/terraform/terraform-plan-diff.mdx (2)

27-30: Definition list for command argument

Replacing the markdown list with <dl> for the component argument improves semantic clarity and consistency.

34-46: Definition list for command flags

The <dl> block covering -s, --stack, --orig, --new, and --skip-init is correctly structured and preserves all descriptions.

website/docs/core-concepts/projects/configuration/opentofu.mdx (1)

56-75: Approve semantic HTML definition list for Terraform options
The <dl> correctly structures the Terraform component settings, improving semantic clarity without altering content.

website/docs/cli/commands/helmfile/usage.mdx (2)

69-72: Use <dl> for arguments section (approved)
The conversion to a definition list correctly represents the required component argument semantically and preserves the original meaning.

74-83: Use <dl> for flags section (approved)
All flags (--stack, --dry-run, --redirect-stderr) are accurately represented in the <dl>, maintaining clarity and content.

website/docs/cli/commands/validate/validate-schema.mdx (1)

52-55: Use <dl> for --schemas-atmos-manifest flag (approved)
The single-flag entry is converted correctly to a definition list entry, keeping the full description intact.

website/docs/cli/commands/validate/validate-stacks.mdx (1)

93-96: Use <dl> for --schemas-atmos-manifest flag (approved)
The definition list entry accurately preserves the existing flag semantics and description.

website/docs/cli/commands/helmfile/helmfile-generate-varfile.mdx (1)

42-45: Use <dl> for arguments section (approved)
The <dl> for the component argument is correctly formatted, making the requirement explicit without content changes.

website/docs/cli/commands/validate/validate-editorconfig.mdx (1)

41-86: Looks good: Semantic definition list for flags is valid.
The <dl> block correctly replaces the previous table and all <dt>/<dd> pairs are balanced.

website/docs/cli/commands/aws/aws-eks-update-kubeconfig.mdx (2)

78-82: Arguments section properly converted to <dl>.
The single-argument <dl> is concise and semantically correct.

86-113: Flags section correctly formatted as a definition list.
All flags are now <dt>/<dd> entries with inline aliases and descriptions.

website/docs/cli/commands/validate/validate-component.mdx (2)

44-47: Argument <dl> is correctly implemented.
The required component term is clearly defined in a semantic list.

49-64: Flags refactored to <dl> as intended.
Each flag description is clear, and the default timeout is noted.

website/docs/cli/commands/describe/describe-component.mdx (2)

70-94: Flags already converted to a semantic list.
The <dl> for flags is well-formed with proper <dt>/<dd> pairs.

101-149: Output sections broken into multiple <dl>s correctly.
Both the top-level and nested <dl> lists are balanced and semantically organized.

Also applies to: 150-195

website/docs/cli/commands/describe/describe-dependents.mdx (3)

250-253: Semantic definition list for Arguments
Switching from a plain list to <dl> adds proper semantics for the CLI arguments.

255-267: Flags section updated to <dl> for clarity
The flag descriptions are now properly grouped under <dt>/<dd> pairs, improving readability.

294-327: Output schema reformatted as HTML definition list
Converting the output fields to <dl> ensures consistent, semantic documentation of each property.

@osterman osterman added the no-release Do not create a new release (wait for additional code changes) label Jun 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
codex no-release Do not create a new release (wait for additional code changes) size/l Large size PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@osterman
0