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 documentation #20

Merged
merged 13 commits into from
Sep 30, 2024
Merged

Update documentation #20

merged 13 commits into from
Sep 30, 2024

Conversation

Y0dler
Copy link
Collaborator

@Y0dler Y0dler commented Sep 26, 2024

Move sections from the paper manuscript to the documentation due to word count restrictions.

@Y0dler Y0dler self-assigned this Sep 26, 2024
@Y0dler
Copy link
Collaborator Author

Y0dler commented Sep 26, 2024

Oh, it looks like the LaTeX formulae are not rendered correctly when you check the build of the documentation...

@Y0dler
Copy link
Collaborator Author

Y0dler commented Sep 26, 2024

According to this, it should work natively already

@michaelosthege
Copy link
Member

@Y0dler I fixed the formula formatting and applied a bunch of different MyST features such as cross references.

Navigation through the docs became a bit of a roller coaster, so IMO we should follow-up with adding a some sectioning to the navigation pane.

But this PR is ready from my side 👍

@Y0dler
Copy link
Collaborator Author

Y0dler commented Sep 30, 2024

Thanks a bunch for all the additions to documentation index!
Sectioning as a follow-up sounds good and we should also change the content on the GitHub landing page (and include a more prominent link to the documentation).

@Y0dler Y0dler merged commit 00de981 into main Sep 30, 2024
5 checks passed
@Y0dler Y0dler deleted the update-documentation branch September 30, 2024 21:09
@github-actions github-actions bot locked and limited conversation to collaborators Sep 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants