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

Add Documentation #225

Open
phschaad opened this issue Jul 5, 2023 · 0 comments
Open

Add Documentation #225

phschaad opened this issue Jul 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@phschaad
Copy link
Collaborator

phschaad commented Jul 5, 2023

The extension desperately needs a good read-the-docs page that explains the extension structure.
We currently have decent code-side API documentation, but the overall structure is opaque to new developers. It is not clear where what functionality lives and what needs to be considered when trying to make additions to the extension.
It needs a clean 'getting started' or 'contributing' guide.

@phschaad phschaad added the documentation Improvements or additions to documentation label Jul 5, 2023
@phschaad phschaad added this to the July 2023 milestone Jul 5, 2023
@phschaad phschaad modified the milestones: July 2023, August 2023 Aug 15, 2023
@phschaad phschaad modified the milestones: August 2023, Backlog Oct 4, 2023
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