Skip to content

[Feature] Docs Website #315

@mrspence

Description

@mrspence

Description

We need a website to host Nanocoder documentation, using Nextra. We want a solution that is easy for contributors to publish docs in, while also offering a clean and future-proof website that can include new tools and libraries in the future.

Over the next couple days I'll prepare the base work and any sensible sub issues to get this on the road!

Key Use Cases

  • Technical docs for our Nanocoder CLI tool
    • Guides for AI providers and MCP server setup
    • Auto-updates when code changes
  • Good search
  • Easy markdown editing for contributors
  • Hosted at docs.nanocollective.org

Proposed Solution

  • Use Nextra
  • Sits on a sub-domain
  • Tenancy support (i.e. Nanocoder, get-md, Nanoflow, ...)
  • Uses CI to auto-publish markdown docs from each project

Documentation Types Needed

  • User Guides (installation, setup, usage)
  • API Reference (automated from TypeScript)
  • Configuration Guides (providers, MCP servers)
  • Architecture Overview (diagrams, design decisions)
  • Developer Documentation (contributing, extending)
  • Troubleshooting & Best Practices

Additional Context

Originally discussed to some extend in #144 - more discussion to follow!

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions