Thinkmill / Thinkmill/keystatic

Provide technical documentation as docblock comments on types

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

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
2.4k
Forks
159
Avg merge
21h 41m
Merged PRs (30d)
2

Description

This way our editors LSP will be able to help us read your documentation without leaving our editor.

Since it's all typescript, i'm only asking for narrative documentation to help explain why someone would want to use particular types.

This might also be an opportunity to create a parser for keystatic that can take in a glob of typescript files and produce content nodes, resulting in the ability to produce technical documentation websites that can intermix natural approachable content with snippets from the parsed code comments.

It's also a chance to start introducing some accountability in the architecture decisions so that team work can scale async, if it was explained in comments what the usecase and purpose of CollectionEntry vs Entry was, then refactorings/additions would be less tedious and shocking in the long run.

Contributor guide

No contributing guide indexed for this repository

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 names no files, so first locate the TypeScript definitions for CollectionEntry and Entry and read their surrounding usage. Clarify whether the goal is narrative docblock comments on the types only or also the proposed parser and documentation-site workflow. Done should mean the agreed types explain their purpose and use cases in editor-visible comments.

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.