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

Reduce duplication, provide clearer learning path in documentation #945

Open
petersilva opened this issue Feb 19, 2024 · 0 comments
Open
Labels
Discussion_Needed developers should discuss this issue. Documentation Primary deliverable of this item is documentation Priority 5 - Defect Missing and/or broken functionality - do not forget

Comments

@petersilva
Copy link
Contributor

Manual review required. I think there is considerable redundancy/room for confusion in that, for example, the following
three documents cover the same ground, all differently... wondering if there is room for rationalization:

https://metpx.github.io/sarracenia/Tutorials/1_CLI_introduction.html
https://metpx.github.io/sarracenia/How2Guides/subscriber.html
https://metpx.github.io/sarracenia/Tutorials/Setup_a_local_subscriber.html
https://metpx.github.io/sarracenia/Tutorials/Setup_a_remote_subscriber.html
Hmm...

Also there are sr3-examples now... It might be good to have a "Start Here" kind of guide to provide a little more guidance for people starting?

@petersilva petersilva added Priority 5 - Defect Missing and/or broken functionality - do not forget Documentation Primary deliverable of this item is documentation Discussion_Needed developers should discuss this issue. labels Feb 19, 2024
@petersilva petersilva changed the title Reduct duplication, provide clearer learning path in documentation Reduce duplication, provide clearer learning path in documentation Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion_Needed developers should discuss this issue. Documentation Primary deliverable of this item is documentation Priority 5 - Defect Missing and/or broken functionality - do not forget
Projects
None yet
Development

No branches or pull requests

1 participant