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

Documentation needed? #114

Open
Leo-Ryu opened this issue Dec 15, 2020 · 0 comments
Open

Documentation needed? #114

Leo-Ryu opened this issue Dec 15, 2020 · 0 comments

Comments

@Leo-Ryu
Copy link

Leo-Ryu commented Dec 15, 2020

Hello,

I’ve been working on a platform for editable codebase documentation and noticed this repo lacked documentation besides the README. Would it be useful if I generated/hosted docs for this repo?

The platform:

  1. has a modern markdown editor to allow people to quickly and easily create new documents/user guides
  2. is similar to readthedocs/sphinx in that reads through the codebase and builds/hosts linkable pages describing classes and functions, as well as their usages in the codebase. However unlike readthedocs/sphinx, it doesn't require any configuration to get up and running
  3. tracks the github repo so that every build has the latest code

Sincerely hoping I can be of use to you and your project!

Cheers,
Leo

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

No branches or pull requests

1 participant