solidjs / solidjs/solid-start

Typescript docs for hooks and components

Open
#442 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
5.9k
Forks
426
Avg merge
1d 3h
Merged PRs (30d)
11

Description

I really like the workflow of this promising framework, but the lack of documentation for practically all exported items of both Solid-Start as well as SolidJS makes feature discovery and API understanding harder than it needs to be. Is this a deliberate decision or just a lack of contributions / difference in prioritization?

If you need help with this, I'm pretty sure some people (like me) are willing to write some documentation for components.

One challenge is to keep the inline JS docs in sync with the website. For example, the useNavigate hook should have documentation on the website as well as in the code.

Tools like tsdoc may help to generate documentation pages from ts comments, keeping both in sync.

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

Start by comparing docs/api/useNavigate.md in SolidStart with the inline documentation at src/routing.ts in solid-router, then review how exported hooks and components are currently documented. Clarify the scope and whether generated pages are expected before choosing a contribution; done would mean the agreed items have synchronized website and inline documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
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.