onflow / onflow/docs

[Improvement] Improve documents layout

Open
#50 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improvement
Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Issue to be solved

Make documents more readable

Suggest A Solution

use these resources for good design references:

What are you currently working on that this is blocking?

No response

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 reviewing the current documents layout and the linked typographic and design references. Define the specific readability changes before making any edits; done should mean the documentation layout is visibly more readable and follows agreed design criteria.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.