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.

Sign up for GitHub

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

Jump to bottom

Update readme introduction and title #27

Merged
merged 4 commits into from
Apr 30, 2024
Merged

Update readme introduction and title #27

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
695e727
feat: introduction & title change
Mar 22, 2024
0389045
fix: newlines
Mar 26, 2024
fe8ea85
fix: title, public&private doc, line wrap
Apr 29, 2024
e17c722
fix: links & format
Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Launchpad Documentation Manual
Copy link
Member

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".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

==============================
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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/).
Copy link
Contributor

Choose a reason for hiding this comment

The 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

bug tracking, and translations. \n The documentation

and

latest features and improvements. \n You can access the lat

But that's mostly personal preference.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
Added the well needed newlines as you suggested (:

Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The 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!

Copy link
Contributor Author

@RuinedYourLife RuinedYourLife Apr 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The 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.

Expand Down
Loading