[M10.4] Documentation site

Open
  • Is something wrong?
#246 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
36/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Start by reading the project’s existing documentation and the M8.2 dependency. The scope names install, concepts, the generated shipkeep.yml reference, CLI reference, and migration guide, but gives no file paths or details about the site structure. Done means a new user can install and deploy using the site alone.

Written by the indexing model from the issue text.

Description

documentation priority:P2 task track:cross-cutting
Task id

M10.4

Track

X: cross-cutting

Scope
  • User docs: install, concepts, shipkeep.yml reference (generated from schema), CLI reference, migration guide.
Acceptance criteria

A new user installs and deploys by following the site alone.

Depends on

M8.2

Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
7h 17m
Merged PRs (30d)
197

Getting set up

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.

More from shipkeepdev/shipkeep

All issues in shipkeepdev/shipkeep

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.