Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Documentation Checklist #9

Open
10 of 12 tasks
cscully-allison opened this issue Nov 22, 2021 · 1 comment
Open
10 of 12 tasks

Documentation Checklist #9

cscully-allison opened this issue Nov 22, 2021 · 1 comment

Comments

@cscully-allison
Copy link
Collaborator

cscully-allison commented Nov 22, 2021 •
edited
Loading

Documentation Needs

Implement the following documentation:

  • Simple Example Notebooks With Multiple Visualizations
  • Autodoc Generation of docstrings Under User Facing API calls

Visualization Developer

  • Installation Instructions
  • Prose form descriptions of with code snippets:
    • Core Interaction with Software
    • Data Assumptions
    • Data Model for 1 Way "Pass by Value"
    • Data Model for 2 Way "Pass by Reference"
  • Draw IO figures of Data Model and Abstract workings of RoundTrip
  • Best Practices
  • WebPack Guidance

Notebook User

  • Clear explanation of ? operator
@cscully-allison
Copy link
Collaborator Author

I am hitting on a lot of these points with a tutorial in the wiki. I will address more theoretical concepts in the future.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cscully-allison