Skip to content

minor doc update #36

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
Merged
merged 7 commits into from
Aug 21, 2023
Merged

minor doc update #36

merged 7 commits into from
Aug 21, 2023

Conversation

vcanogil
Copy link
Collaborator

No description provided.

@codecov
Copy link

codecov bot commented Aug 20, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (a900e9a) 100.00% compared to head (adb355d) 100.00%.

❗ Current head adb355d differs from pull request most recent head 3df4112. Consider uploading reports for the commit 3df4112 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff            @@
##              main       #36   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          111       111           
=========================================
  Hits           111       111

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

berquist
berquist reviewed Aug 21, 2023
View reviewed changes
docs/src/interop.md Outdated
@@ -8,7 +8,7 @@ The documentaiton below provides some essential functionality, such as creating

For a detailed overview, or if you want to know how AtomsBase.jl operates behind the scenes, refer to its official documentation.

## Creating AtomsBase Systems
#### Creating AtomsBase Systems
Copy link
Member

Choose a reason for hiding this comment

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

Why not have this be 3 and AtomsBase.jl be 2? The header level should generally reflect the text hierarchy, and the size of the rendered text is a styling side effect. If we don't like the relative sizes of the doc theme then we can try changing that.

It looks like all the remaining headers should be changed to 3 and Fermi.jl left at 2 since it's non-AtomsBase.

berquist
berquist approved these changes Aug 21, 2023
View reviewed changes
Copy link
Member

@berquist berquist left a comment

Choose a reason for hiding this comment

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

We talked about this at standup and you should make the hierarchy whatever makes the documentation more presentable, in particular the left sidebar.

@vcanogil vcanogil merged commit c78635f into main Aug 21, 2023
@vcanogil vcanogil deleted the dev/minor_docupdate branch August 21, 2023 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@berquist berquist berquist approved these changes

@shivupa shivupa Awaiting requested review from shivupa

@amandadumi amandadumi Awaiting requested review from amandadumi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vcanogil @berquist