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.

Sign up for GitHub

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

Jump to bottom

Document the API #11

Open
4 tasks
zrosenbauer opened this issue Jul 14, 2023 · 0 comments
Open
4 tasks

Document the API #11

zrosenbauer opened this issue Jul 14, 2023 · 0 comments
Labels
type: enhancement New feature or technical improvement.
Milestone
Release v1

Comments

@zrosenbauer
Copy link
Member

zrosenbauer commented Jul 14, 2023 •
edited

Describe the problem you'd like to have solved

Currently there is basically 0 documentation (for a lib thats about making docs...funny)

Describe the ideal solution

  • Document the API for Document
  • Document the API for Text
  • Add descriptions of the classes and how to use
  • Add description of how to extend/override

Alternatives and current work-arounds

👎 Look at the code
🆗 Look at examples

Additional context

nein
@zrosenbauer zrosenbauer added this to the Release v1 milestone Jul 14, 2023
@zrosenbauer zrosenbauer changed the title Documentation Documentation v1 Jul 14, 2023
@zrosenbauer zrosenbauer changed the title Documentation v1 Document the API Jul 14, 2023
@zrosenbauer zrosenbauer added the type: enhancement New feature or technical improvement. label May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: enhancement New feature or technical improvement.
Milestone
Release v1
Development

No branches or pull requests
2 participants
@zrosenbauer @scotty-robot