Skip to content

Power website and documentation with Docusaurus #192

@lordsarcastic

Description

@lordsarcastic

Public documentation on Ahnlich website is currently done manually and without any specific structure.
With the implementation of this issue, documentation, guides, release notes, RFCs and many others will be handled with Docusaurus easily and without pain.

Below is a structure for documentation and webpages we can use

  • Home Page
  • Docs:
    • Overview
    • Installation
    • Building with Ahnlich
      • Book search project
      • Image search project
    • Components
      • Database Engine
      • CLI
      • DSL
      • Client libraries & SDKs
        • Python
        • Rust
        • Contributing to client libraries
      • External Integrations
        • Postgres interoperatability
    • API documentation (GRPC stuff here)
    • Release notes
    • Contributors
    • RFCs
    • Roadmap
    • Index

Below outlines important links that are to be displayed at the top menu of each page

  • Right:
    • GitHub repo
    • docs.rs documentation
    • Search bar
  • Left:
    • Home page (Ahnlich with logo)
    • Guides (for now, links to the "Building with Ahnlich" page but will metamorphize into a full blown list of example of open source stuff people build with Ahnlich components

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions