Minor tweak to docs#5132
Conversation
…ence diagram for cleaner display Docs: Include note about installing D2 as a prerequisite for running
WalkthroughAll changes are documentation-focused: prerequisites section added to README with D2 Diagram Library installation instructions, architecture diagrams rewritten from node/arrow layout to sequence-diagram style showing phase-based message flows, and changelog updated to reflect these documentation changes. Changes
Suggested labels
Suggested reviewers
Poem
🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 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}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
v3/UNRELEASED_CHANGELOG.md (1)
22-23: Use bullet style and tighter phrasing for changelog consistency.These entries read better as standard list items and align with the format shown later in this file.
Suggested patch
-Docs: Change to a couple of diagrams on architecture page to use sequence diagram for cleaner display -Docs: Include note about installing D2 as a prerequisite for running +- Docs: Update architecture page diagrams to sequence-diagram format for cleaner display +- Docs: Add note that D2 must be installed as a prerequisite🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@v3/UNRELEASED_CHANGELOG.md` around lines 22 - 23, The two changelog entries should be converted to standard bullet-list style and tightened for consistency: replace the two lines with prefixed hyphens and more concise phrasing such as "- Use sequence diagrams on the architecture page for cleaner display" and "- Add note: install D2 required to run diagrams" so they match the rest of the file's list format and tone.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/README.md`:
- Around line 7-15: Update the README prerequisites to use correct GitHub
branding and add a fenced code block language; specifically change the "Github
releases" mention in the "D2 Diagram Library" line to "GitHub releases" and
replace the existing indented/unlabeled code block that begins with "# Use
install script:" and contains the curl and go install commands with a
triple-backtick fence declaring the language (e.g., ```bash) so the block is
linguistically labeled for MD040 linting.
---
Nitpick comments:
In `@v3/UNRELEASED_CHANGELOG.md`:
- Around line 22-23: The two changelog entries should be converted to standard
bullet-list style and tightened for consistency: replace the two lines with
prefixed hyphens and more concise phrasing such as "- Use sequence diagrams on
the architecture page for cleaner display" and "- Add note: install D2 required
to run diagrams" so they match the rest of the file's list format and tone.
🪄 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: CHILL
Plan: Pro
Run ID: 662f9016-9b26-486e-936b-e3d4c4d6b2c1
📒 Files selected for processing (3)
docs/README.mddocs/src/content/docs/concepts/architecture.mdxv3/UNRELEASED_CHANGELOG.md
| * [D2 Diagram Library](https://d2lang.com/). You can download the binary manually from [Github releases](https://github.com/terrastruct/d2/releases) or use the following | ||
|
|
||
| ``` | ||
| # Use install script: | ||
| curl -fsSL https://d2lang.com/install.sh | sh -s -- | ||
|
|
||
| # Install from source with Go | ||
| go install oss.terrastruct.com/d2@latest | ||
| ``` |
There was a problem hiding this comment.
Fix docs lint nits in prerequisites block.
Line 7 should use GitHub branding, and Line 9 should declare a fence language to satisfy MD040.
Suggested patch
-* [D2 Diagram Library](https://d2lang.com/). You can download the binary manually from [Github releases](https://github.com/terrastruct/d2/releases) or use the following
+* [D2 Diagram Library](https://d2lang.com/). You can download the binary manually from [GitHub releases](https://github.com/terrastruct/d2/releases) or use the following
-```
+```bash
# Use install script:
curl -fsSL https://d2lang.com/install.sh | sh -s --
# Install from source with Go
go install oss.terrastruct.com/d2@latest</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 LanguageTool</summary>
[uncategorized] ~7-~7: The official name of this software platform is spelled with a capital “H”.
Context: ... can download the binary manually from [Github releases](https://github.com/terrastruc...
(GITHUB)
</details>
<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>
[warning] 9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @docs/README.md around lines 7 - 15, Update the README prerequisites to use
correct GitHub branding and add a fenced code block language; specifically
change the "Github releases" mention in the "D2 Diagram Library" line to "GitHub
releases" and replace the existing indented/unlabeled code block that begins
with "# Use install script:" and contains the curl and go install commands with
a triple-backtick fence declaring the language (e.g., ```bash) so the block is
linguistically labeled for MD040 linting.
</details>
<!-- fingerprinting:phantom:poseidon:hawk:8196d50f-a506-4a6a-9511-ca0331fb4616 -->
<!-- This is an auto-generated comment by CodeRabbit -->
|
✅ Triaged by Wails PR Reviewer This PR has been reviewed and accepted. Head Ref OID: This comment serves as a signature that this PR has been triaged. Future runs will skip this PR based on the headRefOid. |
2 participants
Having spent some time going through the docs to familiarize myself with v3 before hitting the backlog, I'd just like to suggest a couple of very small changes.
I just want to add, good work on the docs. It was a very clean read!
Summary by CodeRabbit