Skip to content

Conversation

PrometheusPi
Copy link
Member

@PrometheusPi PrometheusPi commented Feb 20, 2024

This pull request solves #4818

It adds the link to the style guide and explains that the repo linked before is the discussion on the code style.

  • check if links in *.md work as in *.rst

@PrometheusPi PrometheusPi added the documentation regarding documentation or wiki discussions label Feb 20, 2024
@PrometheusPi PrometheusPi added the CI:no-compile CI is skipping compile/runtime tests but runs PICMI tests label Feb 20, 2024
@chillenzer
Copy link
Contributor

Thanks for taking care of this! To my own surprise the [name](link) syntax seems to work. But the :ref:... syntax failed.

@chillenzer
Copy link
Contributor

Content-wise this seems okay. It's a very minimal solution and does not fully resolve #4818. That was more targeted towards a general overhaul of also docs/source/dev/styleguide.rst because that's outdated, too. But don't let the perfect be the enemy of the good, so please go ahead with this one but leave the issue open.

@PrometheusPi
Copy link
Member Author

The linking works differently in *.md then in *.rst - this the link is not shown properly.
Please do not merge.

@PrometheusPi PrometheusPi marked this pull request as draft February 20, 2024 14:33
@PrometheusPi
Copy link
Member Author

Linking runs into the following issue #4831

@chillenzer
Copy link
Contributor

Which is probably precisely the reason why this was not done properly last time. XD Feel free to close #4831 first!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI:no-compile CI is skipping compile/runtime tests but runs PICMI tests documentation regarding documentation or wiki discussions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants