Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move technical documentation out of glossary #83

Open
xeruf opened this issue Sep 8, 2022 · 5 comments
Open

Move technical documentation out of glossary #83

xeruf opened this issue Sep 8, 2022 · 5 comments

Comments

@xeruf
Copy link
Member

xeruf commented Sep 8, 2022

It is confusing to have glossary-backlinks in the technical documentation at the bottom.
I think we should shorten the glossary pages and move that documentation somewhere appropriate - Christoph also suggested to move the general XML documentation further down since most people won't need it.

@xeruf
Copy link
Member Author

xeruf commented Aug 12, 2023

It is also quite silly that every mention of the word "Computerspieler" or "Wettkampfsystem" links to the glossary. Especially for the latter I would usually rather link to the actual contest system.

@xeruf
Copy link
Member Author

xeruf commented Aug 12, 2023

And we should merge https://docs.software-challenge.de/allgemein/spiel in somewhere - such single-section pages are silly

@jnccd
Copy link
Member

jnccd commented Jan 19, 2024

Christoph also suggested to move the general XML documentation further down since most people won't need it.

Can it go further down?

image

@jnccd
Copy link
Member

jnccd commented Jan 19, 2024

Is this issue already resolved?

@xeruf
Copy link
Member Author

xeruf commented Mar 27, 2024

xml documentation is placed adequately now, but we still have far too long glossary pages this is not resolved

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

No branches or pull requests

2 participants