marigold-dev / marigold-dev/batcher

Add Documentation

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
11
Forks
3
PR merge metrics
No merged PRs in 30d

Description

This issue is to add the common documentation framework into Batcher so that is consistent with the other Marigold projects that will be doing the same

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

Start by comparing Batcher's current documentation with the common framework used by the other Marigold projects. Identify the documentation entry points and framework requirements before making changes; the work is done when Batcher follows that shared documentation structure consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.