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

Documentation policy #144

Open
chrisburr opened this issue Oct 16, 2023 · 3 comments
Open

Documentation policy #144

chrisburr opened this issue Oct 16, 2023 · 3 comments

Comments

@chrisburr
Copy link
Member

Maybe its worth having a separate documentation repository which describes all supported versions?

@chaen
Copy link
Contributor

chaen commented Oct 16, 2023

I think it's best to have the doc versioned together with the code. Splitting the two showed not to work in DIRAC

@jmrocha
Copy link

jmrocha commented Jun 21, 2024

Hi DiracX team, I noticed the project is missing a dedicated documentation website. You might already have plans in place, but I wanted to give a suggestion of a potential solution. Feel free to check out this proof-of-concept made with Docusaurus (code here.) The next step would be to integrate searching and add the API documentation generated by a different tool (e.g., Sphinx.)

@chaen
Copy link
Contributor

chaen commented Jun 26, 2024

Thanks a lot @jmrocha
Docusaurus is definitely one of the tool to try in the coming weeks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants