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

extensive documentation? #89

Open
blue-apparition opened this issue Jul 6, 2021 · 1 comment
Open

extensive documentation? #89

blue-apparition opened this issue Jul 6, 2021 · 1 comment

Comments

@blue-apparition
Copy link

Hello!

May I suggest you to write extensive documentation?

I'm a little familiar with (python) Flask web microframework. It alone has extensive User Guide, with lots of example code, and advice. Beginning with "Quickstart" (kind of advertising overview), then Tutorial, then covering standard tools, then advanced issues, and eventually, API. Look at it, it's a great example of documentation. Each module Flask is usually used with (like login, forms, templates, database, etc) also has similar extensive documentation.

Same with nginx: lots of documentation, examples, FAQs, (official) blog posts.

For ulib, I only see a very short wiki (by jonathan kelly). For such a huge project (much larger than Flask), only a short "getting started"?!

Examples are great, but, in my perhaps not very humble opinion, there should be an intermediate-level documentation: use cases with key code excerpts.

Suppose you die. Will this great kid of yours continue to live its life on its own?

What do you think?

@stefanocasazza
Copy link
Owner

stefanocasazza commented Jul 7, 2021 via email

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

2 participants