Skip to content

feat(docs): set up Docusaurus in ./docs directory #449

@evgheni7

Description

@evgheni7

Overview

Set up Docusaurus in the ./docs directory to publish the existing Markdown documentation as a proper documentation website.

Current State

The ./docs directory already contains the following Markdown files:

Root:

  • overview.md
  • commands.md
  • configuration.md
  • development.md
  • examples.md
  • troubleshoot.md

guide/:

  • getting-started.md
  • environments.md
  • configurations.md
  • providers.md
  • functions.md
  • registries.md
  • resources.md
  • local-nodes.md
  • remote-nodes.md
  • plugins.md

registry/:

  • auth.md

Tasks

  • Initialise Docusaurus inside ./docs (using the classic preset)
  • Map existing .md files into the Docusaurus sidebar structure (preserve current directory layout)
  • Configure docusaurus.config.js with project name, URL, and branding (use existing logo assets already in ./docs)
  • Add a CI job (GitHub Actions) to build and deploy the site (e.g. GitHub Pages)
  • Ensure ./docs is self-contained — do not move source .md files out of their current locations

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions