-
-
Notifications
You must be signed in to change notification settings - Fork 274
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
Increases clarity in staging process. #1698
Conversation
Hi, A thing that I have observed is that: As a reader for 'getting started' I kept jumping from link to link without completely reading all the instructions. For example: the sentence - Look at the example recipe in the staged-recipes repository` And I am assuming there are many readers like me (more experienced ofc!) who fall into a pile of mishaps they could have avoided if only they had read all the instructions. A possible solution: Shall we put up the instructions on going around Grayskull, CRAN (Not my forte!), and the example recipe within this document itself? |
@kathatherine @beckermr @BastianZim do you think it's a good idea to do so? |
@chicken-biryani I love sphinx tabs. Anaconda, where I work, is thinking of adding that to our own docs. Please write up an example of what you're thinking and I'd love to look at it. Anything that can increase clarity for the user and keep them from wandering away from the documentation flow is a good idea to me. |
@kathatherine
I'll create a separate draft PR for that? It may get a little messy but I think it's worth a shot. |
Co-authored-by: Jaime Rodríguez-Guerra <[email protected]>
@chicken-biryani Yes, a separate PR would probably be the way to go. Maybe even an entirely separate issue? |
@kathatherine on it! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me!
Powercycling for CI |
Hi, I am clubbing my ideas for the adding packages into a single PR over here: Will wind up the work asap! |
Ah ok. Was trying to triage and get in PRs that seemed ready to merge |
PR Checklist:
src
directory, not indocs
or in the html filesThis PR hopes to increase clarity for a reader by: