Skip to content

docs: v1 - diataxis framework (backport #2105)#2194

Merged
melekes merged 2 commits intov1.xfrom
anton/diataxis
Jan 30, 2024
Merged

docs: v1 - diataxis framework (backport #2105)#2194
melekes merged 2 commits intov1.xfrom
anton/diataxis

Conversation

@melekes
Copy link
Collaborator

@melekes melekes commented Jan 30, 2024

Manual backport of #2105

close: #1613 

New structure for documentation using the [diataxis
framework](https://diataxis.fr). Created landing pages for the major
sections and re-organized the existing content into one of the 4 topics
of the diataxis framework (tutorials, how-to guides, technical reference
and explanation)


#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [ ] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec
@melekes melekes requested review from a team as code owners January 30, 2024 09:16
@melekes melekes requested a review from a team January 30, 2024 09:16
@melekes melekes changed the base branch from main to v1.x January 30, 2024 09:17
@melekes melekes closed this Jan 30, 2024
@melekes melekes reopened this Jan 30, 2024
@melekes melekes self-assigned this Jan 30, 2024
@melekes melekes requested a review from andynog January 30, 2024 13:32
Copy link
Collaborator

@andynog andynog left a comment

Choose a reason for hiding this comment

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

lgtm, thanks @melekes for opening the PR

@melekes melekes merged commit 7cfb6c8 into v1.x Jan 30, 2024
@melekes melekes deleted the anton/diataxis branch January 30, 2024 15:22
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.

2 participants