Skip to content

Add documentation to public API and create documentation artifacts (e.g., website, PDF, etc.) #19

Description

@marip8

Now that the code-base exists and seems to be functional, it would be beneficial to use an agent to make a first pass at creating documentation for the public API (e.g., using Doxygen) and to compile that documentation into HTML format (potentially hosted on the Github Pages site for this repository). This would be beneficial for end-users to become familiar with how to use the API and can help on-board new developers more effectively.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions