HakaiInstitute / HakaiInstitute/hakai-api-client-py

Add docs site

Open
#29 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

As this package grows, it would be nice to have a docs site for people to explore the package a little. Options for a docs site include:

- quarto
- mkdocs-material

Contributor guide

Open the contributing guide

Research direction

The issue names Quarto and MkDocs Material as candidate documentation tools, but provides no files, tests, or entry point. First define the documentation scope and choose between those options; done means a documentation site exists for people to explore the Python package.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.