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

Tweak documentation sections #6065

Merged
merged 4 commits into from
Dec 20, 2024

Conversation

jkonecny12
Copy link
Member

Current documentation is starting to be more and more confusing and hard to orient. This PR is trying to improve the issue by creating developer subsection and moving advanced topics there.

Also fix sections leaking into TOC for release.rst.

These are generated files.
This file is copied from CONTRIBUTING.rst project root directory.
We don't want to modify the copied content.
Currently everything is in one level when you open the Anaconda
documentation. There is a lot of topics. Let's make the documentation
a bit more structured.

Adding developer directory but also a page with this content so it is
more hidden.
The release.rst documentation used top level section for sub-sections.
That resulted that these were visible in the main table of content which
was confusing.
@github-actions github-actions bot added the f42 Fedora 42 label Dec 20, 2024
Copy link
Contributor

@M4rtinK M4rtinK left a comment

Choose a reason for hiding this comment

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

Looking good - yeah, this might indeed help with the structure - thanks! :)

@jkonecny12
Copy link
Member Author

/kickstart-test --waive docs only

@jkonecny12 jkonecny12 merged commit c13da85 into rhinstaller:main Dec 20, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants