HSF / HSF/phoenix

Improve documentation with all the recently added features

Open
#908 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
88
Forks
105
Avg merge
16h 15m
Merged PRs (30d)
34

Description

A lot of new functionality has been added and we need to update all the documentation to match. I will update this ticket with specific items but I wanted the placeholder in place so as not to forget.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name any documentation files, features, tests, or entry points. Wait for the promised specific items before starting; completion cannot be verified until the documentation scope and affected features are defined.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.