Skip to content

DOCS: Sets up docs for Squirrel #50

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.

Sign up for GitHub

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

Jump to bottom
Draft
YektaY wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

DOCS: Sets up docs for Squirrel #50

YektaY wants to merge 2 commits into from

Conversation

@YektaY
Copy link
Collaborator

@YektaY YektaY commented Jan 26, 2026

Description

Sets up docs for Squirrel

Motivation

Creates a user guide and documentation for users and future developers

Pre-merge checklist

  • Code works interactively
  • Code follows the style guide
  • 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

@YektaY YektaY self-assigned this Jan 26, 2026
@YektaY YektaY added the documentation Improvements or additions to documentation label Jan 26, 2026
@YektaY YektaY linked an issue Jan 26, 2026 that may be closed by this pull request
Setup documentation and link to "Help" button #7
Open
@YektaY YektaY force-pushed the yektay/docs branch 2 times, most recently from e7021b0 to 8de8eaf Compare January 28, 2026 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@YektaY YektaY

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Setup documentation and link to "Help" button

2 participants

@YektaY