Skip to content

docs: Comply with Diátaxis#732

Open
PierreQuinton wants to merge 2 commits into
mainfrom
dev-docs-diataxis
Open

docs: Comply with Diátaxis#732
PierreQuinton wants to merge 2 commits into
mainfrom
dev-docs-diataxis

Conversation

@PierreQuinton

Copy link
Copy Markdown
Contributor

This dev branch makes the transition toward compliance with Diátaxis.

  • Changes docs to reference
  • Create Explanation
  • Create Tutorials
  • Create How-to guides

We can partial merge this to main with any release.

When merging main to this, should verify:

  • docs/source/docs is empty, if not, it should be moved to docs/source/reference and cross references should be fixed.

@PierreQuinton PierreQuinton requested a review from a team as a code owner June 11, 2026 09:40
@PierreQuinton PierreQuinton added the cc: docs Conventional commit type for changes to the documentation. label Jun 11, 2026
@ValerianRey ValerianRey added the breaking-change This PR introduces a breaking change. label Jun 11, 2026
@github-actions github-actions Bot changed the title docs: Complies with Diátaxis docs!: Complies with Diátaxis Jun 11, 2026
@ValerianRey

ValerianRey commented Jun 11, 2026

Copy link
Copy Markdown
Member

Really cool to see that there was some effort to standardize the technical documentation specs.
I still have to read it thoughoughly.

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.

@ValerianRey ValerianRey removed the breaking-change This PR introduces a breaking change. label Jun 11, 2026
@github-actions github-actions Bot changed the title docs!: Complies with Diátaxis docs: Complies with Diátaxis Jun 11, 2026
@ValerianRey

ValerianRey commented Jun 11, 2026

Copy link
Copy Markdown
Member

If I understand correctly:

  • We have some tutorials but very basic and a bit outdated IMO (https://torchjd.org/stable/examples/basic_usage/, maybe some parts of the readme)
  • We have some how-to-guides, which are the rest of our examples. I think those are quite ok, even though we could add more / improve the existing / reorder them.
  • We don't really have Explanation apart from the paper and the beginning of the readme. We could probably improve a bit on that.

IMO we should mainly improve on tutorials and simplify the readme (which is currently a mix of everything).

@PierreQuinton

Copy link
Copy Markdown
Contributor Author

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.

@PierreQuinton PierreQuinton changed the title docs: Complies with Diátaxis docs: Comply with Diátaxis Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cc: docs Conventional commit type for changes to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants