docs: Correction of indentation #216
Conversation
WalkthroughThe changes update the structure and formatting of the tutorial's Table of Contents in the documentation. The list style was changed from numbered to bulleted with improved indentation and consistent section titles. A new section, "Create a Secret for Token," was inserted between existing steps. Section headings were reworded for uniformity, and the YAML code snippet's indentation was corrected for clarity. No changes were made to the actual instructional content or code logic. Changes
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
wiki/Tutorial.md (1)
6-18: Uniform bullet list indentation and consistency in Table of Contents.The Table of Contents correctly switches to a bulleted format and adds the new "Create a Secret for Token" entry matching its heading, but nested items use mixed indentation (4 spaces for some, 2 for others), leading to markdownlint MD007 warnings. To improve readability and satisfy linting, please standardize on 2-space indentation for all second‑level bullets.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing preposition found.
Context: ...orkflow) - Final step - The end # Generate token 1. ...(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
7-7: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
wiki/Tutorial.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
wiki/Tutorial.md
[uncategorized] ~18-~18: Possible missing preposition found.
Context: ...orkflow) - Final step - The end # Generate token 1. ...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
wiki/Tutorial.md
7-7: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (1)
wiki/Tutorial.md (1)
105-107: YAML code snippet properly nested underjobs.The
buildjob and its properties are now correctly indented beneathjobs, clarifying the workflow structure. This change aligns with YAML best practices—LGTM!
Ichi075
force-pushed
the
docs/fix-wiki-code-example
branch
from
f25bfa8 to
7bb1d85
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
wiki/Tutorial.md (2)
6-18: Improve list indentation consistency in the Table of ContentsThe nested items in your TOC (lines 7, 10–11, and similarly under "Create a workflow") use 4 spaces, which triggers markdownlint MD007. It’s best to stick with 2 spaces per indent level for nested bullets. The new "Create a Secret for Token" entry is correctly placed and the anchors match their headings, so semantically you’re good—just adjust the whitespace for linting and readability. For example:
### Table of Contents - [Let's get started!](#lets-get-started) - - [Table of Contents](#table-of-contents) - [Generate token](#generate-token) - [Select a repo](#select-a-repo) - - [New repo](#new-repo) - - [Existing repo](#existing-repo) + [Let's get started!](#lets-get-started) + - [Table of Contents](#table-of-contents) + [Generate token](#generate-token) + [Select a repo](#select-a-repo) + - [New repo](#new-repo) + - [Existing repo](#existing-repo) ...🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing preposition found.
Context: ...orkflow) - Final step - The end # Generate token 1. ...(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
7-7: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
105-109: Standardize YAML indentation for workflow snippetIn the code block under
jobs:, thebuildjob and its fields are indented by 4 and 6 spaces. To follow YAML best practices (and align with GitHub Actions docs), use 2 spaces per level:jobs: - build: + build: - runs-on: ubuntu-latest + runs-on: ubuntu-latest - name: generate-github-cards + name: generate-github-cards - permissions: + permissions: - contents: write + contents: writeThis ensures clarity and consistency in your examples.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
wiki/Tutorial.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
wiki/Tutorial.md
[uncategorized] ~18-~18: Possible missing preposition found.
Context: ...orkflow) - Final step - The end # Generate token 1. ...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
wiki/Tutorial.md
7-7: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
10-10: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
Summary by CodeRabbit