Skip to content

DOC: Add API Keys Info to Documentation#66

Open
zdomke wants to merge 2 commits intomainfrom
zdomke/api-key-docs
Open

DOC: Add API Keys Info to Documentation#66
zdomke wants to merge 2 commits intomainfrom
zdomke/api-key-docs

Conversation

@zdomke
Copy link
Copy Markdown
Contributor

@zdomke zdomke commented Mar 30, 2026

Description

Update the documentation to include information on API Keys.

Includes info on:

Motivation

Closes #35

Where Has This Been Documented?

Various places in the documentation, but mostly in the new api-keys.md page (view after running mkdocs serve)
http://127.0.0.1:8000/react-squirrel-backend/getting-started/api-keys/

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions

@zdomke zdomke requested a review from a team March 30, 2026 18:41
@zdomke zdomke self-assigned this Mar 30, 2026
@zdomke zdomke added the documentation Improvements or additions to documentation label Mar 30, 2026
@zdomke zdomke requested a review from shilorigins March 31, 2026 00:03
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

Successfully merging this pull request may close these issues.

[DOCS] - Add documentation for API Keys

2 participants