Move the ts-results fork documentation out of the readme #150
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jstasiak
requested review from
a team,
rbruggem,
raguiar9080,
charcarr,
0bex0 and
jasharifestina
|
We're following https://diataxis.fr/ here. Open question, should it be "Explanations" or maybe something else?
|
raguiar9080
approved these changes
Jul 4, 2024
There was a problem hiding this comment.
Open question, should it be "Explanations" or maybe something else?
- Key topics
- Background
- Explanation (note: no "s" at the end)
I think considering the current content Background also fits quite well but Explanations works. I would use the singular version though Explanation
|
Yup, I'll change to Explanation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following up on the work started in [1].
Applied some necessary changes to the content since we're migrating from Markdown to reStructuredText.
Following the Diataxis framework[2] for structuring the documentation.
[1] 633ccad ("Set up an initial documentation structure (#81)")
[2] https://diataxis.fr/