Skip to content

Conversation

@benjaminhuth
Copy link
Member

PLEASE DESCRIBE YOUR CHANGES.
THIS MESSAGE ENDS UP AS THE COMMIT MESSAGE.
DO NOT USE @-MENTIONS HERE!

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

@benjaminhuth benjaminhuth changed the title Correct links in getting_started.md fix: Correct links in getting_started.md Jan 19, 2026
@github-actions github-actions bot added this to the next milestone Jan 19, 2026
@github-actions github-actions bot added the Component - Documentation Affects the documentation label Jan 19, 2026
@paulgessinger
Copy link
Member

I think the links are correct, but the getting started page is potentially not linked in the doc at the moment.

@benjaminhuth
Copy link
Member Author

benjaminhuth commented Jan 19, 2026

Hmm I think this cannot work when coming to the getting_started.md from the github README.md view, because it tries to link to a local anchor...

@paulgessinger
Copy link
Member

paulgessinger commented Jan 19, 2026

Where do we get there from GitHub?

Ah, from the README. I suppose that should link to the rendered documentation then? Otherwise we could also keep that part of the documentation outside of doxygen.

@benjaminhuth
Copy link
Member Author

Yeah, that would probably be good

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

Labels

Component - Documentation Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants