Skip to content

Create document for complete workflow #12

Closed
@xames3

Description

@xames3
  • from the initial understanding of the narrative, need to create a document which encapsulates the complete workflow from start to finish. The document must be simple and easy to follow along and can help contributors to easily and more intuitively get started with the whole workflow.
  • need to check with @jfmartinez4, @gv2325 and @kyttmacmanus what they are expecting and how deeply (verbosely) the document should be written. Assigning this one to you guys for reviewing and suggesting the edits.
  • a few important notes about the documentation, @gv2325 or @jfmartinez4 feel free to add more information below:
    • the document should be comprehensive enough to get people/contributors started but not to the point it overwhelms them.
    • the document should provide support for all major OS environments (macOS, Windows and Linux). At least getting the tool-setup part should be covered in this document.
    • the document should consist of all the latest images/screenshots for that particular narrative.
    • the document should provide links to supporting articles and have some basic troubleshooting guides (at least the most common ones).

if anything, please do add below.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

communitycontributions from the community or enhancements that support community engagementdiscussion neededpull requests that need community or team input before moving forwarddocumentationupdates, additions, or improvements to the project’s documentationhelp wantedextra attention is needed and appreciate some helphigh prioritypull requests that should be reviewed and merged as a priority due to their importanceneeds testingpull requests that need to be tested or validated before they can be mergedopen sciencecontributions that enhance transparency, reproducibility, or accessibility in line with Open Sciencequestionfurther information is requested by the team members or communitytestadditions or modifications to the project’s testing suite

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions