Skip to content

Fixing documentation bugs#832

Open
fstagni wants to merge 3 commits intoDIRACGrid:mainfrom
fstagni:docs_bugs
Open

Fixing documentation bugs#832
fstagni wants to merge 3 commits intoDIRACGrid:mainfrom
fstagni:docs_bugs

Conversation

@fstagni
Copy link
Contributor

@fstagni fstagni commented Mar 12, 2026

closes #797

@read-the-docs-community
Copy link

read-the-docs-community bot commented Mar 12, 2026

Documentation build overview

📚 diracx | 🛠️ Build #31796621 | 📁 Comparing f17b773 against latest (f0eb91c)


🔍 Preview build

Show files changed (3 files in total): 📝 2 modified | ➕ 1 added | ➖ 0 deleted
File Status
assets/home.html 📝 modified
developers/index.html ➕ added
overrides/main.html 📝 modified

@fstagni fstagni marked this pull request as ready for review March 12, 2026 16:03
{% block announce %}
<div style="text-align: center;">
🚧 DiracX is still in development and might not yet be suitable for your needs. See the <a href="/roadmap/">roadmap</a> for details. 🚧
🚧 DiracX is actively developed. If you intend to get in touch, see the <a href="developers/">developers</a> page. 🚧
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is the message we want to pass. As of today, you can't do anything with diracx alone. I believe the roadmap should still be linked at the top, and the warning stay very explicit until you can at least submit jobs or do something

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What we discussed is that:

  • the roadmap should still be present, but its content needs to be revisited: Update the contents of the roadmap #819
  • we said to not link the roadmap from the top because it sounded too much a work in progress. Now, it clearly is a work in progress, but we wanted at the same time to emphasize that "it works". DiracX standalone will take a long time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we said to not link the roadmap from the top because it sounded too much a work in progress

I don't think that was a consensus in the meeting. I strongly disagree with changing the wording from "work in progress" until we can run jobs at the very least.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was not written "work in progress" even before, and I did not remove the 🚧 emoji. I can reword a bit, but I would not link the roadmap there until we have re-written it.

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.

[Bug]: documentation bugs

4 participants