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

📚 [Documentation] - Complete API functionality documentation #27

Open
5 tasks
edwardchalstrey1 opened this issue Nov 20, 2024 · 0 comments
Open
5 tasks
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardchalstrey1
Copy link
Collaborator

Section of Documentation

Researcher -> Loading Seshat data in Python via the Seshat API

Description of Improvement

  • Remove the documentation for this repo as we'll use the documentation on the main seshat repo
  • [Optional] Open a new issue to be a completed at a later date on automatic documentation for the various functions?
    • For now, better to rely on tutorial notebooks as there aren't many functions anyway

This page should be renamed to "Using the Seshat API" and have the following sections:

  1. Loading Seshat data in Python: Move over the quick start docs but still refer to the tutorials for showing how the functions work
    • Document better what each notebook shows and the functions used
  2. Loading Seshat data in R - see ✨ [Feature request] - R version of Seshat API package #25
  3. Using the API on the website: include a screenshot of the filter feature

Benefits of Improvement

Easier to use the Seshat API

Additional Context

No response

Definition of Done

  • The documentation improvement has been developed on a branch.
  • A pull request has been created for the new branch to be merged into the main branch.
@edwardchalstrey1 edwardchalstrey1 added the documentation Improvements or additions to documentation label Nov 20, 2024
@edwardchalstrey1 edwardchalstrey1 self-assigned this Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant