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

major restructure of the documentation #851

Merged
merged 2 commits into from
Oct 24, 2024
Merged

major restructure of the documentation #851

merged 2 commits into from
Oct 24, 2024

Conversation

zerothi
Copy link
Owner

@zerothi zerothi commented Oct 24, 2024

New sections, and moved the viz section to a more
sensible name.
Perhaps it should be changed altogether.
Currently the ASE viz has been removed, is it even required? It might be easier to just document ASE conversion.

@pfebrer what do you say to this restructuring?

I think we should strive to move the sections a bit closer so the navigation is more intuitive.

The current layout looks something like this:

image

Suggestions?

New sections, and moved the viz section to a more
sensible name.
Perhaps it should be changed altogether.
Currently the ASE viz has been removed, is it even required?
It might be easier to just document ASE conversion.

Signed-off-by: Nick Papior <[email protected]>
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.89%. Comparing base (bed5fe7) to head (1970caf).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #851   +/-   ##
=======================================
  Coverage   86.89%   86.89%           
=======================================
  Files         403      403           
  Lines       52434    52434           
=======================================
  Hits        45561    45561           
  Misses       6873     6873           

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

@pfebrer
Copy link
Contributor

pfebrer commented Oct 24, 2024

Looks good to me! ASE visualization was just something that was there before sisl.viz, I think indeed it can be removed.

@zerothi zerothi merged commit bc41504 into main Oct 24, 2024
17 checks passed
@zerothi zerothi deleted the doc-changes branch October 24, 2024 10:28
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