Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Power website and documentation with Docusaurus #192

Open
lordsarcastic opened this issue Feb 1, 2025 · 0 comments
Open

Power website and documentation with Docusaurus #192

lordsarcastic opened this issue Feb 1, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lordsarcastic
Copy link
Collaborator

lordsarcastic commented Feb 1, 2025

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
@lordsarcastic lordsarcastic added the documentation Improvements or additions to documentation label Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant