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

Restructure docs a bit more #1548

Merged
merged 9 commits into from
Jun 13, 2024
Merged

Restructure docs a bit more #1548

merged 9 commits into from
Jun 13, 2024

Conversation

visr
Copy link
Member

@visr visr commented Jun 11, 2024

Follow-up to #1541
Fixes #1548

visr added 3 commits June 11, 2024 22:12
@visr visr requested a review from evetion June 11, 2024 21:48
docs/_quarto.yml Outdated
Comment on lines 12 to 17
- text: "Tutorials"
file: tutorial/index.qmd
- text: "How-to guides"
file: guide/index.qmd
- text: "Explanation"
file: explanation/index.qmd
Copy link
Member

Choose a reason for hiding this comment

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

I don't mind changing any of the titles, but note I consciously chose different names than how diataxis names/splits its system (which is for writers of documentation, not end-users). Indeed, this is fine per diataxis:

Explanation by any other name:

Your explanation documentation doesn’t need to be called Explanation.

Alternatives include:

  • Discussion
  • Background
  • Conceptual guides
  • Topics

In the different names, I tried to find names that (I think) are clear to end-users, and took inspiration from a page like https://quarto.org/. Maybe @gijsber can comment on the preferred names (feel free to suggest others)?

Tutorials or Get Started
Guides or How-to guides
Background or Explanation

This PR removes also the About header, which is the same as the logo, but for me it's not clear the logo is a link to the home page. I prefer to add it back (can be another name, such as Home).

Copy link
Contributor

@gijsber gijsber Jun 12, 2024

Choose a reason for hiding this comment

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

My suggestions would be
Home
Getting Started
How-to
Background
Reference

@SnippenE : For the Home page, I wonder if we should include a contact point.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm fine with adding back the home page, though perhaps "Overview" like in https://quarto.org/ is more accurate and less internet-lingo, especially if we want to make PDF docs out of this as well.

I should've included my reasoning for renaming in the PR description, but I didn't have time anymore. They are:

  • Tutorials: Diátaxis says they are for learning. This may include advanced topics in tutorial format. For that "Getting started" does not seem the right title. Quarto.org uses this and then combines a How-to install guide with some tutorials. Installation is a more of a guide, not a tutorial.
  • How-to guides: They are guides that tell you how to do something. I think it's clearer to write it out, it's not long.
  • Explanation: I feel like "Background" is much narrower that "Explanation". Some of the content there is background information, but not all that is needed for understanding is background information. Also background seems less important.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok. Fine with your explanation to go for Tutorials, How-to guides.
Although I am fine with Explanation, we might also consider if Understanding is an appropriate alternative. Other words, like Concepts can be too narrow and Background may indeed not trigger people to read and understand.

Copy link
Member Author

Choose a reason for hiding this comment

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

Understanding is the goal. But we cannot do that, only provide a good explanation and hope it leads to understanding. I think that is why it is not in the alternative names list that @evetion linked to.

visr added 4 commits June 13, 2024 11:28
@gijsber
Copy link
Contributor

gijsber commented Jun 13, 2024

Should the Validation part in Concepts/Implementation not be moved to the Reference section, possibly under a different name e.g. Network connectivityor Network connectivity validation rules

visr added 2 commits June 13, 2024 12:41

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@visr visr merged commit 53c6f7c into main Jun 13, 2024
24 checks passed
@visr visr deleted the diataxis branch June 13, 2024 11:50
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.

None yet

3 participants