Skip to content

Feature: Adopt Sourcey for automated and modern API documentation #155

Description

@codeboost-tr

Currently, the API reference documentation is generated via custom python scripts. I propose adopting Sourcey as the primary documentation engine for \quater.

Why Sourcey?

  1. Modern UI/UX: Out-of-the-box support for dark mode, mobile responsiveness, and clean typography.
  2. Built-in Search: Instant client-side search across all API references without extra configuration.
  3. Automated Navigation: Automatically builds the sidebar based on directory structure.
  4. Maintenance: Replaces custom markdown-generation boilerplate with a standardized, community-backed tool.

I have already prepared a working implementation (PR #154) that migrates the existing API reference to \sourcey-docs\ to demonstrate how it works. Let me know if you would be open to this migration!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions