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

Test an alternative to sphinx #1977

Closed
wants to merge 3 commits into from
Closed

Conversation

anbraten
Copy link
Contributor

@anbraten anbraten commented Feb 24, 2024

Missing some features like a "modern" search, accessibility, ... in the current sphinx framework, I have tried to use vitepress with the docs content.

You can check the result here: https://grubby-pain.surge.sh

I haven't spent too much time on it as I wanted to get some feedback first if you would even consider updating the docs framework / layout.

TODOS (if we want to continue here)

@anbraten anbraten changed the title Test Test a modern alternative to sphinx Feb 24, 2024
@anbraten anbraten changed the title Test a modern alternative to sphinx Test an alternative to sphinx Feb 24, 2024
@Philoul
Copy link
Contributor

Philoul commented Feb 24, 2024

How is managed the different translations?
I don't see anywhere within the link proposed with english "introduction page" the "/en/" we can change with language code.
We can easily switch one link to any language, just by replacing language code, and it's important to keep this capability.
You have to know that we can't show the french language within menu (constraint from french health authorities 🤬).
So it's important to be able to access to language code from all links, especially for hidden translations...

@anbraten
Copy link
Contributor Author

I don't see anywhere within the link proposed with english "introduction page" the "/en/" we can change with language code.

It is currently configured that en can be left out and is the default. For another language the url would be sth like /de/, but it can also be configured that every language is having a language code in the url.

You have to know that we can't show the french language within menu (constraint from french health authorities 🤬).

We could just hide fr from the menu as well.

There are quite some possibilities, but I wanted to get some feedback for this proof-of-concept first before continuing anything.

@anbraten
Copy link
Contributor Author

anbraten commented Feb 24, 2024

I've updated the page to always use /en/... or /de/... and so on. Seems to work quite well.

@peterleimbach
Copy link
Collaborator

Hi Anton,
I am organizing the work on the documentation.
Thank you for your interest on helping us.
I think it‘s best to have a short discussion via FB messenger or Discord to allign.
At the moment we are not looking to replace the Sphinx engine.
The main reason is that we are in a text, structure rework of the project and capacity for doing change on engine and text, structure. This will last at least the next 6 month as we are only doing it in freetime.
The second point is that we have some other requirements a new engine needs to fulfill and not only the engine but the whole chain we use including the Crowdin parser if we use special markdown tags e.g.. We had a look at mkdocs which other T1D projects use but decided to postpone the topic after the rework as we see no major issues with the engine at the moment.
The new engine must be capable of LTR and RTL text too as we habe Hebrew language to support too.
Please contact me on FB or Discord that we can arrange a short session to introduce ourselves and discuss how and when you might help us. I live in Heppenheim not far from you if your information on the web is right.

@peterleimbach
Copy link
Collaborator

@anbraten As discussed not at the moment please as we are working at the moment on text and not the markdown engine. We will come back to this point later this year I think and will then discuss the topic with several stakeholders (user perspective, translators perspective, operation of the site) and the different possibilities (markdown engines) we have got as options.

I close the PR. Please save your work on your repo for future use.

@LegoChemist 4yi

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

Successfully merging this pull request may close these issues.

3 participants