decompals / decompals/slinky

Document file format

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

Nobody has claimed this yet.

Dominant language
Linker Script
Stars
12
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Write down the format, all the options and how they work.

Probably use markdown files inside the docs/ folder

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 reviewing the project's existing files and the docs/ folder to identify the file format and its available options. Done means markdown documentation in docs/ explains the format, every option, and how each option works.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.