Skip to content

Sequential Navigation in How-To Guides #138

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jrcain-usgs
Copy link
Contributor

@jrcain-usgs jrcain-usgs commented Mar 5, 2025

  • Arranges some docs in a sequential order that should be helpful for someone clicking through our docs.
    • Gives a bit of direction to users trying to learn astro software.
  • Adds ← Previous and → Next cards to help users navigate/discover docs.
  • Adds a few cards as jumping off points from the How-To category page.

If people like this structure/navigation, it could be added to other series of our docs as well.

Touches on:

Some screenshots

How-To Page:
Screenshot 2025-03-05 at 14 52 09

Inter-doc navigation:
Screenshot 2025-03-05 at 14 52 58

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

@Kelvinrr
Copy link
Collaborator

I like the cards, we need to use those more often. When we first created this repo I think that feature was a "premium" feature. But some of the flow feels awkward, I think we are going to do this we need everything in a group flow into all the other of the pages on the list, and not just some.

@jrcain-usgs
Copy link
Contributor Author

we are going to do this we need everything in a group flow into all the other of the pages on the list, and not just some.

We do need to add more pages into flows like this, but I'd argue to do it incrementally - start with what we have here and add more later. Also added some in #129 (though that PR has some unrelated unresolved comments)

@jrcain-usgs jrcain-usgs mentioned this pull request Apr 3, 2025
1 task
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