Skip to content

Docs: Adding a pattern for reusing "Only on Read the Docs for Business" admonition (Diátaxis refactor) #9754

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

Merged
merged 3 commits into from
Nov 23, 2022

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Nov 22, 2022

In preparation for Diátaxis, we want an easy way to mix Explanation, How-tos and References so "Read the Docs for Business" features can be listed next to all other features, rather than a separate parallel structure.

The proposal here is quite simple:

  • Use a DRY pattern for including the same admonition in all current RTD4B features
  • We can always adjust the text later, once we see it in different contexts. I don't think we need to spend time on that now, as we cannot see how/where the admonition box will appear. But I could add an action item for Iteration 4.

Related: #9745


📚 Documentation previews 📚

@benjaoming benjaoming added the Improvement Minor improvement to code label Nov 22, 2022
@benjaoming benjaoming requested a review from a team as a code owner November 22, 2022 17:07
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Simple enough 👍

@benjaoming benjaoming merged commit c5b136f into readthedocs:main Nov 23, 2022
@benjaoming benjaoming deleted the docs-business-feature branch November 23, 2022 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants