-
Notifications
You must be signed in to change notification settings - Fork 54
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
docs: enrich the landing page with basic concepts #472
docs: enrich the landing page with basic concepts #472
Conversation
@AnneCYH Isn't there a standard structure we use for home page introductions? I think I remember Dora mentioning something like that. |
Co-authored-by: Ben Hoyt <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is fine as an incremental improvement - thanks.
hi @benhoyt , @IronCore864 , The standard landing page for product docs: There should be ~4 paragraphs to introduce the user to the product. |
Hey @IronCore864 , @benhoyt , looks good! |
Co-authored-by: Ben Hoyt <[email protected]>
…ore864/pebble into docs-complete-set-of-prerequisites
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, let's merge this!
Improve the definition of Pebble and add fundamentals.
In the current version, it only describes what Pebble can do, but most product docs start with defining "what it is", like
supervisor
,runit
, etc, so I expanded the definition a little bit.Also added a section as prerequisite. Maybe it is not necessary, please provide your feedback. I think it doesn't hurt because it has a few links to ubuntu.com.
Closes #465.