Skip to content

Feature: Adopt Sourcey for automated and modern API documentation website #14

Description

@codeboost-tr

I propose adopting Sourcey to generate an automated and modern API documentation website for \ imeseed.

Why Sourcey?

  1. Interactive Reference: Features like instant search, mobile responsiveness, and dark mode out-of-the-box.
  2. Dedicated Documentation: Separation of detailed API/class references from the main README.md.
  3. Automated Publishing: Pre-configured GitHub Actions to deploy to GitHub Pages on every push automatically.

I have already prepared a complete implementation in PR #13 which adds the Sourcey config and pages covering the full API surface (functions, classes, exceptions, and CLI) with clean structure and examples. Let me know if you would be open to this addition!

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