Skip to content

Separate the TOC sections#4651

Open
LecrisUT wants to merge 2 commits intoteemtee:mainfrom
LecrisUT:docs/toc
Open

Separate the TOC sections#4651
LecrisUT wants to merge 2 commits intoteemtee:mainfrom
LecrisUT:docs/toc

Conversation

@LecrisUT
Copy link
Member

@LecrisUT LecrisUT commented Mar 6, 2026

Hopefully this helps with navigability a bit

Signed-off-by: Cristian Le <git@lecris.dev>
@LecrisUT LecrisUT added documentation Improvements or additions to documentation review | trivial Very easy for review, even for beginners, so don't be afraid to have a look! :-) labels Mar 6, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the main table of contents in the documentation into separate, captioned sections to improve navigability. A syntax error in one of the new links needs to be corrected.

@github-project-automation github-project-automation bot moved this to backlog in planning Mar 11, 2026
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@LecrisUT LecrisUT moved this from backlog to review in planning Mar 11, 2026
@happz
Copy link
Contributor

happz commented Mar 11, 2026

Why not, although I'd wait for few more approvals, the actual grouping might be a point of discussion.

@LecrisUT LecrisUT mentioned this pull request Mar 16, 2026
@psss
Copy link
Member

psss commented Mar 19, 2026

Copy pasting the structure brainstorm from #4704:

  • How it works under the hood
    • The basic split/flow of user tree + (user config) -> run -> step -> phase -> test
    • The various trees and directories
    • The split between guest
    • Plugins
    • (Recipe eventually)
    • Glossary
    • Advance topics:
      • Phases that create other phases
      • Profiles/Policies
      • Phases that jump across steps, e.g. dist-git discover and upgrade
  • What feature is available right now/How to use tmt
    • Specification/Features what you can do: multi-host, restart, hardware, etc.
    • External plugins
    • Examples and guides
    • Projects that use tmt and their feedback
  • Code details
    • Python API
    • Config reference/index

@psss psss mentioned this pull request Mar 19, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation review | trivial Very easy for review, even for beginners, so don't be afraid to have a look! :-)

Projects

Status: review

Development

Successfully merging this pull request may close these issues.

4 participants