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.

Sign up for GitHub

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

Jump to bottom

Set up mdbook #26236

Closed
Johennes opened this issue Sep 25, 2023 · 0 comments · Fixed by #26367
Closed

Set up mdbook #26236

Johennes opened this issue Sep 25, 2023 · 0 comments · Fixed by #26367
Assignees
@t3chguy
Labels
A-Developer-Experience A-Documentation T-Task Tasks for the team like planning

Comments

@Johennes
Copy link
Contributor

We have reasonably good documentation in matrix-react-sdk, element-web and element-desktop. However, it's sprinkled across several markdown files and hard to navigate and discover.

@t3chguy suggested that we could set up a guide based on https://rust-lang.github.io/mdBook/ similar to what Synapse does and deploys on GitHub pages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@t3chguy t3chguy

Labels
A-Developer-Experience A-Documentation T-Task Tasks for the team like planning
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Set up mdbook in github pages element-hq/element-web
2 participants
@Johennes @t3chguy