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

Updating embedded links in docs with new file names "tutorial_" and "how_to_" #2578

Merged
merged 3 commits into from
Apr 17, 2024

Conversation

erinvisser
Copy link
Contributor

@erinvisser erinvisser commented Apr 11, 2024

📝 Description

Type: 📝 documentation

Renaming files, in PR #2563, based on their type of documentation (following Diataxis framework) caused issues in the documentation, because these files are embedded throughout the documentation.
I went through and found circumstances of these embedded links and updated the file names. I also went through the index pages for each section and updated the file names accordingly.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@erinvisser erinvisser changed the title Updating embedded links in docs with new file names "tutorial_" and "how_to_ Updating embedded links in docs with new file names "tutorial_" and "how_to_" Apr 11, 2024
@tardis-bot
Copy link
Contributor

tardis-bot commented Apr 11, 2024

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@jvshields
Copy link
Contributor

This looks like a positive change to me, but I do have one comment maybe worth discussing on a larger level. I'm not sure calling things "tutorial" will signify a difference compared to a "how to" to somebody trying approaching our documentation to learn. We've talked a good bit now about the difference, and the goals of one versus another, but before we talked about those things I'm not sure I would have seen a difference.

Trying to put myself in the shoes of somebody approaching our documentation, I think if I saw either "how to" or "tutorial" I'd expect to be learning about how to use the software in either way (though people can disagree if they think otherwise). Maybe instead of saying "tutorial" we should aim for a more descriptive title for the tutorials to make it clear that those tutorials aim to teach somebody how the thing works. Like instead of "tutorial_convergence_plot" it would be called something like "Constructing_and_customizing_convergence_plots."

This sounds much harder and like a lot more work, but I'm mostly not convinced that the word "tutorial" will mean something specific to a user the way it means something to us, having talked about diataxis.

@andrewfullard andrewfullard merged commit b7e0772 into tardis-sn:master Apr 17, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants