docs: Comply with Diátaxis#732
Conversation
… old location to new ones.
75cb642 to
204a6ba
Compare
|
Really cool to see that there was some effort to standardize the technical documentation specs. I put the breaking change flag because this will break some existing links (from outside of torchjd to our docs). But I don't think it's a big issue (it's not like there are so many of those links out there). EDIT: just saw the redirecting script. If I understand correctly the old links will still work. Removing the breaking change flag. |
|
If I understand correctly:
IMO we should mainly improve on tutorials and simplify the readme (which is currently a mix of everything). |
|
Exactly right, the goal of this is not to do all of it, just to go in that direction/structure. This definitely will break the ice for newcomers, while keeping experts comfortable. I believe this is a significant improvement. So my goal for now is really to structure it that way, then we shall of course make the content changes. |
This dev branch makes the transition toward compliance with Diátaxis.
docstoreferenceWe can partial merge this to main with any release.
When merging main to this, should verify:
docs/source/docsis empty, if not, it should be moved todocs/source/referenceand cross references should be fixed.