search

fzi-forschungszentrum-informatik / Lanelet2

Map handling framework for automated driving
BSD 3-Clause "New" or "Revised" License
800 stars 327 forks source link

Broken Links within Mkdocs Documentation #330

Closed DavUhll closed 2 months ago

DavUhll commented 9 months ago

In the current state of the MkDocs documentation, numerous links are broken due to the targeting of README.md files that are copied before creating the documentation. E. g. click on Edit on GitHub. This issue is raised to initiate a discussion on aligning the documentation for better coherence and usability.

The primary objective of this discussion is to explore strategies and potential solutions to streamline the Mkdocs documentation and its folder structure, ensuring that links are functional and direct users to the intended resources effectively.

Let's collaborate to enhance the usability and accessibility of the documentation.

Please feel free to provide your thoughts and suggestions in the comments below.

github-actions[bot] commented 6 months ago

This issue is stale because it has been open for 90 days with no activity. Is this issue still work in progress? If yes, mark it as "WIP" or comment, otherwise it will be closed in 30 days.

m-naumann commented 6 months ago

Is there a way with reasonable effort to modify links in this stage?

https://github.com/fzi-forschungszentrum-informatik/Lanelet2/blob/4789fde6c3bafcd5a8d721d11c5d92870ca59a22/.github/workflows/cd.yaml#L141-L142

github-actions[bot] commented 3 months ago

This issue is stale because it has been open for 90 days with no activity. Is this issue still work in progress? If yes, mark it as "WIP" or comment, otherwise it will be closed in 30 days.

github-actions[bot] commented 2 months ago

This issue was closed because it has been stalled for 30 days with no activity.