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

Clean up docs and shorten README #206

Merged
merged 13 commits into from
Jul 31, 2024
Merged

Clean up docs and shorten README #206

merged 13 commits into from
Jul 31, 2024

Conversation

aelligp
Copy link
Collaborator

@aelligp aelligp commented Jul 30, 2024

This PR addresses #204 and cleans some rendering errors in the docs & links the pkg.

@aelligp
Copy link
Collaborator Author

aelligp commented Jul 30, 2024

@luraess

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Additional details and impacted files

📢 Thoughts on this report? Let us know!

README.md Outdated Show resolved Hide resolved
@luraess
Copy link
Member

luraess commented Jul 30, 2024

@aelligp seems that some files like code of conduct, contributing, authors are duplicated and not properly rendered - needs a fix.

@aelligp
Copy link
Collaborator Author

aelligp commented Jul 31, 2024

code of conduct, contributing, authors are duplicated and not properly rendered

Code of conduct, authors, etc are generated from files in the root of the repo.
The rendering issues for contributions.md are fixed. License and code of conduct remain indented as it is a copy of official documents (see Trixi.jl)

aelligp and others added 2 commits July 31, 2024 12:47
@aelligp aelligp merged commit 37dae58 into main Jul 31, 2024
11 of 12 checks passed
@aelligp aelligp deleted the pa-cleandocs branch July 31, 2024 13:04
@aelligp aelligp mentioned this pull request Jul 31, 2024
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.

3 participants