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.

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

Re-organise the doc pages #108

Merged
merged 3 commits into from
Mar 5, 2024
Merged

Re-organise the doc pages #108

merged 3 commits into from
Mar 5, 2024

Conversation

nvaytet
Copy link
Member

@nvaytet nvaytet commented Mar 1, 2024 •
edited
Loading

  • Made a User guide section
  • Made folders for Loki, Isis instrument, and Common tools
  • Added quick links to those on the index
  • Added installation instructions
  • Removed the Examples folder

Fixes #107

SimonHeybrock
SimonHeybrock reviewed Mar 4, 2024
View reviewed changes
docs/developer/index.md Outdated
Comment on lines 6 to 9
## Table of contents

```{toctree}
---
maxdepth: 2
hidden:
---
Copy link
Member

Choose a reason for hiding this comment

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

Why deviate from the common template?

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought we were allowed to try things out and if we like them we can propagate them to the template?

Copy link
Member

Choose a reason for hiding this comment

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

Sure, but is there a reason why having the TOC here is not good? The page is pretty empty, and the TOC adds some quick-navigation aid.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair enough, I put it back in 👍

Copy link
Member

Choose a reason for hiding this comment

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

I think you edited the wrong file in your latest commit. My comment was about the dev docs, not the general docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

oops...

@nvaytet nvaytet merged commit 5bf1ff1 into main Mar 5, 2024
3 checks passed
@nvaytet nvaytet deleted the improve-docs branch March 5, 2024 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SimonHeybrock SimonHeybrock SimonHeybrock approved these changes

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

Successfully merging this pull request may close these issues.

Improve documentation
2 participants
@nvaytet @SimonHeybrock