-
Notifications
You must be signed in to change notification settings - Fork 16
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
Update readme introduction and title #27
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,10 @@ | ||
Launchpad Documentation Manual | ||
============================== | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is rst, so you need to have the underline the same length as the heading. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed |
||
|
||
Welcome to the official Launchpad Documentation Manual. This manual is designed to help users, developers, and contributors understand and utilize the extensive features of Launchpad more effectively. It covers a wide range of topics, from basic navigation within Launchpad to advanced features such as code hosting, bug tracking, and translations. The documentation is structured to provide guidance for all levels of users, whether you are new to Launchpad or an experienced user looking to deepen your knowledge. This manual is continuously updated to reflect the latest features and improvements. You can access the latest version of the documentation at [https://documentation.ubuntu.com/launchpad/en/latest/](https://documentation.ubuntu.com/launchpad/en/latest/). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The text sounds great 👍 Only thing I'd do is add a couple of new-lines at
and
But that's mostly personal preference. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, please wrap the lines after 80 characters - except for links. We probably should either specify this or set up a formatter/linter to make aware of this - sorry for these kind of nitpicks. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As mentioned above, we will have two places for documentation. The other one will be focused on non-public information, this one on public one, and will address both Launchpad users and Launchpad developers such as the Launchpad team. Maybe you could reflect this in the text? Thank you! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. added a paragraph that clarifies the existence of both a public and private manual depending what your needs are and who you are also hard wrapped lines after 80 characters |
||
|
||
Documentation starter pack | ||
========================== | ||
-------------------------- | ||
|
||
See the `Sphinx and Read the Docs <https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/>`_ guide for instructions on how to get started with Sphinx documentation. | ||
|
||
|
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.
Could you please change this to "Launchpad Manual"? This will be the name, rather than a description.
We will have this one, and another one for non-public things, which will be called the "Launchpad Admin Manual".
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.
fixed