You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm presently working on the contribution guide and have been thinking about how our various docs work together and how to avoid duplicating content (which would create more opportunities for things to be out of sync or out of date).
A possibly incomplete list of our various docs include:
I'd like to propose a couple of principles to help guide all docs moving forward. These aren't necessarily changes:
Assume that most people want docs on how to use the STRUDEL kit, followed by copyright/licensing info, followed by how to contribute to STRUDEL.
Include relevant information in the doc type that is likely to be most popular and link to it from less popular locations unless norms suggest otherwise. For example, information about the anatomy of a task flow is relevant to both docs on how to use STRUDEL kit and docs on contributing to it. How to use it is likely a more popular set of docs, so the info on anatomy of a task flow should be detailed there and just linked to from docs on contributing. However, licensing information might be relevant to the docs on using STRUDEL kit but norms dictate that that info should go in a LICENSE.md file, so we would put that info in a markdown file and link to it elsewhere.
All docs should be accessible via Github and the strudel.science website
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I'm presently working on the contribution guide and have been thinking about how our various docs work together and how to avoid duplicating content (which would create more opportunities for things to be out of sync or out of date).
A possibly incomplete list of our various docs include:
I'd like to propose a couple of principles to help guide all docs moving forward. These aren't necessarily changes:
Thoughts? Other principles to follow?
Beta Was this translation helpful? Give feedback.
All reactions