Skip to content

Conversation

@tmadlener
Copy link
Member

@tmadlener tmadlener commented Sep 27, 2025

BEGINRELEASENOTES

  • Rework the landing page to not just be a TOC.

ENDRELEASENOTES

This is the (very) first (of probably many) step(s) towards a revamped documentation. This doesn't do too much restructuring yet, but it makes the landing page a bit more usable by providing some high level information instead of just being a TOC.

  • Homogenize the link names from the landing page and their names in the side-bar.
  • Adapt some of the short descriptions in the Getting Started Main Documentation Sections

One thing that I am also curious about is: Should we keep the current version around during the restructuring and put a link to that on to the main page, until we are done?

@github-actions
Copy link

github-actions bot commented Sep 27, 2025

PR Preview Action v1.6.2

🚀 View preview at
https://key4hep.github.io/key4hep-doc/pr-preview/pr-113/

Built to branch gh-pages at 2025-11-04 16:35 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@kjvbrt
Copy link
Contributor

kjvbrt commented Nov 4, 2025

Can there be a link directly to the https://github.com/key4hep somewhere on the main page?

@tmadlener
Copy link
Member Author

I have added it in a sentence Quick Start section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants