Skip to content

feat(docs): initialize Docusaurus site structure - #18

Merged
shadowmkj merged 8 commits into
mainfrom
feat/docs
Aug 8, 2026
Merged

feat(docs): initialize Docusaurus site structure#18
shadowmkj merged 8 commits into
mainfrom
feat/docs

Conversation

@shadowmkj

@shadowmkj shadowmkj commented Aug 7, 2026

Copy link
Copy Markdown
Owner

Initializes the Docusaurus site structure in for project documentation.

This PR sets up the foundation for Docusaurus so collaborators can work on adding documentation content for the project.

Closes #17

Summary by CodeRabbit

  • New Features

    • Added a complete documentation website with a homepage, navigation, sidebar, responsive feature section, and customizable light/dark themes.
    • Added tutorials covering documentation, pages, blogs, Markdown, deployment, versioning, and localization.
    • Added blog examples, author profiles, tags, and an example standalone Markdown page.
  • Documentation

    • Added setup, local development, production build, and deployment guidance.
    • Added examples for interactive MDX components and common documentation workflows.

Repository owner deleted a comment from coderabbitai Bot Aug 7, 2026
@shadowmkj
shadowmkj marked this pull request as draft August 7, 2026 13:52
coderabbitai[bot]

This comment was marked as outdated.

Repository owner deleted a comment from coderabbitai Bot Aug 7, 2026
Add comprehensive Docusaurus documentation covering setup, getting
started, installation options, configuration in `config.toml`, authentication
flow, CLI subcommand reference, TUI keybindings, Neovim side-by-side split
integration, crate architecture, GraphQL/REST API integration, caching
mechanics, and contributor guide.

Also add `@easyops-cn/docusaurus-search-local` for offline search and
a GitHub Actions workflow to deploy the site to GitHub Pages.
@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (1)
  • docs

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 904a1d38-f06a-4ba5-8cd0-0549b15e96de

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

@shadowmkj
shadowmkj dismissed coderabbitai[bot]’s stale review August 8, 2026 16:12

Review for documentation not needed for now

@shadowmkj
shadowmkj marked this pull request as ready for review August 8, 2026 17:23
@shadowmkj
shadowmkj merged commit 23275a1 into main Aug 8, 2026
8 of 9 checks passed
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.

feat: extensive project documentation using Docusaurus

1 participant