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

Improve documentation for website #202

Open
Mia-Y-Kelly opened this issue Jan 22, 2024 · 2 comments
Open

Improve documentation for website #202

Mia-Y-Kelly opened this issue Jan 22, 2024 · 2 comments

Comments

@Mia-Y-Kelly
Copy link

I'd like to update the docs so that the descriptions of the functions are included on the README's. The links to the actual code are nice, but it would be more intuitive to have them also included on the website.

@Tyriar
Copy link
Member

Tyriar commented Jan 25, 2024

Not sure what you mean by adding the function descriptions to the readmes?

@Mia-Y-Kelly
Copy link
Author

I may be incorrect, but it looks like the website pulls from Markdown files like this (for example) to show documentation. I would like to update them to include more verbose descriptions.

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

No branches or pull requests

2 participants