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

Update docsy to v0.8.0 #1699

Merged
merged 6 commits into from
Feb 27, 2024
Merged

Update docsy to v0.8.0 #1699

merged 6 commits into from
Feb 27, 2024

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented Dec 26, 2023

I tried to apply the minimum set of changes I could to have no changes in the generated spec. Each commit can be reviewed separately and the description usually explains why the change is needed.

After the style fixes I applied, the only visible change that I could spot is that now the code blocks have a button at the top right to copy the content, and I am not sure whether we should remove it or not:

Capture d’écran du 2023-12-26 11-34-13

This as a draft for now because it is based on my personal fork so the website can be built while waiting for matrix-org/docsy#2 to be merged.

Preview: https://pr1699--matrix-spec-previews.netlify.app

This is the recommended way to use it now.
Also I couldn't get Hugo to work with Docsy v0.8.0 as a git submodule.

Uses a development branch on my personal fork for now,
until changes are merged in matrix-org/docsy.

Signed-off-by: Kévin Commaille <[email protected]>
This is the recommended way to add/overwrite Docsy styles.

Signed-off-by: Kévin Commaille <[email protected]>
Copy the upstream file and change just the necessary parts
to have the same content as before.
Switches to have the main menu declared in Hugo's config file.

Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
@zecakeh zecakeh requested a review from a team as a code owner December 26, 2023 10:54
Signed-off-by: Kévin Commaille <[email protected]>
@zecakeh zecakeh marked this pull request as draft December 26, 2023 10:56
Signed-off-by: Kévin Commaille <[email protected]>
@zecakeh zecakeh marked this pull request as ready for review December 27, 2023 19:26
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@richvdh richvdh merged commit b136b35 into matrix-org:main Feb 27, 2024
12 checks passed
@zecakeh zecakeh deleted the update-docsy branch February 27, 2024 18:45
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