Page MenuHomeSoftware Heritage

Make it explicit that the "main" docs page is actually devel doc
AbandonedPublic

Authored by ardumont on Thu, Oct 14, 9:34 AM.

Details

Reviewers
None
Group Reviewers
Reviewers
Summary

This is only symlinked since the impact of a plain renaming is not clear.

Motivation:
Stop being confused at the /devel sphinx instance is actually on disk named "docs".

It was true as long as we only had one sphinx instance, we now have 3, so that no longer makes sense.
And it's confusing at best.

Open for discussion, maybe we should just rename it?

Test Plan

make -C devel html is happy

Diff Detail

Repository
rDDOC Development documentation
Branch
add-devel-link-to-docs
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 24447
Build 38150: arc lint + arc unit

Event Timeline

zack retitled this revision from Explicit the main docs page is actually the devel instance to Make it explicit that the "main" docs page is actually devel doc.Thu, Oct 14, 9:49 AM

What is the motivation for this change?

motivation

Answered in the description, gist of it is "to reflect the docs reality today".

duh, sorry, I missed it

no, no, don't worry, i updated the description to explicit as much after you asked ;)
I mentioned it in irc, not here so my bad.

I don't know if it's really relevant. The docs/ folders of other packages are the devel docs too; and I feel that adding a symlink here might just make things more confusing when debugging.

Maybe just mention it at the top of swh-docs/README.rst?

meh, let's just say it's irrelevant.