Skip to content

docs: convert docs to markdown, add TUI guide, fix sidebar layout - #11

Merged
nazozokc merged 1 commit into
mainfrom
AI-agent
Jun 17, 2026
Merged

docs: convert docs to markdown, add TUI guide, fix sidebar layout#11
nazozokc merged 1 commit into
mainfrom
AI-agent

Conversation

@nazozokc

@nazozokc nazozokc commented Jun 17, 2026

Copy link
Copy Markdown
Owner

Summary

Convert the documentation site from Svelte () to Markdown () for easier editing, add a new Interactive TUI guide, and fix the sidebar layout on desktop.

Changes

Markdown conversion

  • Added mdsvex as SvelteKit markdown preprocessor
  • Converted 7 content pages from \ → :
    • Commands, Installation, Configuration, Usage Guides, Data & Storage, Development, FAQ
  • Created a shared MarkdownLayout component that handles frontmatter (title/description) and wraps content in the docs styles
  • Homepage () and layout () remain as Svelte

New page: Interactive TUI guide

  • Step-by-step walkthrough of \ and \ interactive prompts
  • Documents validation rules, tag autocomplete hints, confirmation defaults
  • Added to sidebar navigation

Layout fix

  • Sidebar is now fixed at viewport left edge on desktop (was centered within max-width container)
  • Header nav and main content align properly after the sidebar

Verification

  • \undefined
    [ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL] Command "test" not found

Did you mean "pnpm test"?: 51/51 tests pass

  • \undefined
    [ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL] Command "build" not found

Did you mean "pnpm build"? (docs): builds successfully

Summary by CodeRabbit

  • Documentation

    • Added comprehensive documentation pages covering installation, commands, configuration, data storage, development setup, FAQ, usage guides, and interactive TUI behavior.
  • Refactor

    • Migrated documentation from component-based approach to markdown-based pages for improved maintainability.
  • Style

    • Updated sidebar navigation layout with improved fixed positioning and spacing on desktop displays.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The docs site adds mdsvex as a dev dependency and configures it in svelte.config.js to preprocess .md files via a new MarkdownLayout.svelte component. All existing hand-written .svelte documentation pages are deleted and replaced with equivalent .md files. The desktop sidebar is changed from sticky to fixed positioning, and an "Interactive TUI" nav link is added.

Changes

Docs site mdsvex migration

Layer / File(s) Summary
mdsvex tooling and MarkdownLayout
docs/package.json, docs/svelte.config.js, docs/src/lib/layouts/MarkdownLayout.svelte
Adds mdsvex ^0.12.7 as a dev dependency, expands extensions to [".svelte", ".md"], wires MarkdownLayout.svelte as the mdsvex layout, and implements that layout with conditional title, meta description, and h1 rendering from frontmatter props.
Sidebar CSS and nav link
docs/src/app.css, docs/src/routes/+layout.svelte
Switches the desktop sidebar from position: sticky to position: fixed with explicit coordinates and height, resets aside nav max-width and margins, shifts the layout offset to .layout/nav padding, and adds an "Interactive TUI" entry to the Guides nav section.
Doc pages migrated to Markdown
docs/src/routes/installation/+page.md, docs/src/routes/configuration/+page.md, docs/src/routes/commands/+page.md, docs/src/routes/data/+page.md, docs/src/routes/guides/+page.md, docs/src/routes/tui/+page.md, docs/src/routes/faq/+page.md, docs/src/routes/development/+page.md
Deletes all existing .svelte documentation pages and introduces equivalent .md files with frontmatter-driven title/description, full content covering installation, configuration, CLI commands, data/storage schema, usage guides, interactive TUI walkthroughs, FAQ, and development setup.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop, hop — the .svelte pages are gone,
Now .md files carry the docs along!
mdsvex weaves Markdown with flair,
A MarkdownLayout floating fixed in the air.
The sidebar stands firm, no longer it slips —
A bunny approved this with twitching lip-tips! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: converting docs to markdown, adding a TUI guide, and fixing sidebar layout—all primary objectives reflected in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch AI-agent

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/routes/configuration/`+page.md:
- Around line 41-43: The fenced code blocks in the configuration documentation
are missing language identifiers, which violates markdownlint rule MD040. Locate
the two fenced code blocks that display the currency codes list and the billing
cycles list, and update their opening fence markers by adding the language
identifier text (change ``` to ```text) to both the opening fence on lines 41
and 47 respectively. This will comply with markdownlint requirements and enable
proper syntax highlighting.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8557c763-a8e6-4fe8-b7ae-d922dd260db1

📥 Commits

Reviewing files that changed from the base of the PR and between 22f87bb and 9aac54a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (20)
  • docs/package.json
  • docs/src/app.css
  • docs/src/lib/layouts/MarkdownLayout.svelte
  • docs/src/routes/+layout.svelte
  • docs/src/routes/commands/+page.md
  • docs/src/routes/commands/+page.svelte
  • docs/src/routes/configuration/+page.md
  • docs/src/routes/configuration/+page.svelte
  • docs/src/routes/data/+page.md
  • docs/src/routes/data/+page.svelte
  • docs/src/routes/development/+page.md
  • docs/src/routes/development/+page.svelte
  • docs/src/routes/faq/+page.md
  • docs/src/routes/faq/+page.svelte
  • docs/src/routes/guides/+page.md
  • docs/src/routes/guides/+page.svelte
  • docs/src/routes/installation/+page.md
  • docs/src/routes/installation/+page.svelte
  • docs/src/routes/tui/+page.md
  • docs/svelte.config.js
💤 Files with no reviewable changes (7)
  • docs/src/routes/development/+page.svelte
  • docs/src/routes/data/+page.svelte
  • docs/src/routes/faq/+page.svelte
  • docs/src/routes/installation/+page.svelte
  • docs/src/routes/commands/+page.svelte
  • docs/src/routes/configuration/+page.svelte
  • docs/src/routes/guides/+page.svelte

Comment on lines +41 to +43
```
JPY USD EUR GBP AUD CAD KRW CNY SGD HKD
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Specify language for fenced code blocks to comply with markdownlint.

Lines 41 and 47 contain fenced code blocks without a language identifier. Add ```text (or ```plaintext) to each to comply with MD040 and enable proper syntax highlighting.

🔧 Proposed fix
 ## Currency & cycle choices

 ### Supported currencies (10)

-```
+```text
 JPY  USD  EUR  GBP  AUD  CAD  KRW  CNY  SGD  HKD
-```
+```
 
 ### Supported billing cycles (6)

-```
+```text
 weekly  bi-weekly  monthly  quarterly  semi-annual  yearly
-```
+```

Also applies to: 47-49

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 41-41: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/src/routes/configuration/`+page.md around lines 41 - 43, The fenced code
blocks in the configuration documentation are missing language identifiers,
which violates markdownlint rule MD040. Locate the two fenced code blocks that
display the currency codes list and the billing cycles list, and update their
opening fence markers by adding the language identifier text (change ``` to
```text) to both the opening fence on lines 41 and 47 respectively. This will
comply with markdownlint requirements and enable proper syntax highlighting.

Source: Linters/SAST tools

@nazozokc
nazozokc merged commit a754502 into main Jun 17, 2026
1 check passed
@nazozokc
nazozokc deleted the AI-agent branch June 17, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant