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

README 2.0 #137

Open
MatthewRalston opened this issue Apr 6, 2024 · 2 comments
Open

README 2.0 #137

MatthewRalston opened this issue Apr 6, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed invalid This doesn't seem right wontfix This will not be worked on

Comments

@MatthewRalston
Copy link
Owner

This would be nice alongside of the interface 'update'.

Needs way more modern and updated usage header.

Possibly include schemas

But maybe the new README should just reflect the new UI, metadata, and schemas printed to stdout, along with the logging module changes... maybe an additional

Errors.md

should be produced to describe the various types of errors and what may trigger them. Referring to the Sphinx docstrings where appropriate to recall the TypeErrors, ValueErrors, KeyErrors etc. that may be raised.

@MatthewRalston MatthewRalston added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers invalid This doesn't seem right wontfix This will not be worked on labels Apr 6, 2024
@MatthewRalston MatthewRalston added this to the Interface Revision milestone Apr 6, 2024
@MatthewRalston MatthewRalston self-assigned this Apr 6, 2024
@MatthewRalston
Copy link
Owner Author

Condense header, leave the "beta" disclaimer under the development subheader, and make usage go before install. Show the primary two workflows (prof-> matrix -> dist., and graph -> assemble) succinctly.

  • Also, make website links more easily accessible.

  • Is TOC necessary?

  • any subheaders missing?

  • maybe make subcommands headers in usage area link to their own page, with the expanded help and more detailed description?

@MatthewRalston
Copy link
Owner Author

  • Dramatically condense acknowledgements to just that.

  • usage statement details can be moved to quickstart page.

  • whole readme needs to feel sleek and modern

  • usage .gif

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed invalid This doesn't seem right wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant