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

rewrite docs #152

Closed
6 tasks
NickleDave opened this issue Mar 29, 2022 · 3 comments
Closed
6 tasks

rewrite docs #152

NickleDave opened this issue Mar 29, 2022 · 3 comments
Assignees
Labels
DOC: documentation Documentation
Projects

Comments

@NickleDave
Copy link
Collaborator

NickleDave commented Mar 29, 2022

  • make index / landing page much less wordy
  • fix reference to "songdeck" at bottom of landing page
  • have a formats section -- do not hide in reference
  • "use crowsetta with your format" should go into how-tos and it should not be the first how-to; first should be on converting to 'simple-seq' format
  • "tutorial" currently under "table of contents" should get its own section
  • "finding out what formats are built-in" should be a how-to, and it should be done in passing in the tutorial
@NickleDave
Copy link
Collaborator Author

landing page structure should be:

  • elevator pitch + features list
  • install
  • quickstart
    • use built-in data here
  • Bug reports and feature requests
  • Need help?
    • link to vocalpy forum
  • contributing
    • link to vocalpy CoC
  • How to Cite
  • License and credits

@NickleDave NickleDave self-assigned this Apr 4, 2022
@NickleDave NickleDave added the DOC: documentation Documentation label Apr 4, 2022
@NickleDave NickleDave added this to In progress in ENH Apr 4, 2022
@NickleDave
Copy link
Collaborator Author

NickleDave commented Apr 4, 2022

  • overall sections
    • formats
      • don't want to hide these in a "reference" since they are kind of the main point
    • user guide
    • reference
      • API
        • want to make sure the interface is surfaced in the docs somehow
      • background (?)
        • anything that is not format specific but more like "why does this package exist"

not sure how much typical sections I think of like "getting started/tutorial", "howtos", make sense here since the functionality is in some ways very targeted

@NickleDave
Copy link
Collaborator Author

  • use furo theme but with always-light hack that pandera has?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC: documentation Documentation
Projects
ENH
Done
Development

No branches or pull requests

1 participant