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

Cleanup README / docs #467

Open
Half-Shot opened this issue Apr 24, 2023 · 0 comments
Open

Cleanup README / docs #467

Half-Shot opened this issue Apr 24, 2023 · 0 comments
Labels
T-Documentation Improvements or additions to documentation

Comments

@Half-Shot
Copy link
Contributor

The README should be cleaned up a bit, something similar to https://github.com/matrix-org/matrix-hookshot (albeit, probably with a better format for the featureset). We should ideally move component documentation to our hosted documentation site, and have it either inline with the code or in markdown documents. Nobody uses a README for documentation if they can help it :)
@Half-Shot Half-Shot added the T-Documentation Improvements or additions to documentation label Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Half-Shot