add getting started toctree, introduction and help pages #82
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tmadlener
reviewed
Dec 23, 2024
docs/getting_started/help.md
Outdated
|
|
||
| For issues or requests related to the documentation, please use the [bugtracker](https://github.com/key4hep/key4hep-doc/issues). | ||
|
|
||
| For discussions or help with a specific Key4hep package, you can open a request on its repository's bug tracker. A [list of repositories](https://github.com/orgs/key4hep/repositories) is available on GitHub. |
There was a problem hiding this comment.
I think we should also add a sentence here about opening an issue on key4hep-spack as a catch-all for issues where people either don't know the package (or don't want to find out). Effectively similar to what we are already doing in the setup script.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BEGINRELEASENOTES
ENDRELEASENOTES
Adding introduction and help pages, disabling "edit on github" as discussed during key4hep in person meeting.
Another toctree was created to move introductory topics and give them more visibility. The contribution page was reorganized so the pages are less hidden and easier accessible