Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Adding a Simple Summary at the Top of a Complex Page

Adding a Simple Summary at the Top of a Complex Page

Comments
1 min read
Correcting a Wrong File Name in a Tutorial

Correcting a Wrong File Name in a Tutorial

Comments
1 min read
Updating Screenshots to Match the Current UI

Updating Screenshots to Match the Current UI

Comments
1 min read
Fixing a Broken Example Link

Fixing a Broken Example Link

Comments
1 min read
Adding a Simple Summary at the Top of a Complex Page

Adding a Simple Summary at the Top of a Complex Page

Comments
1 min read
Why You Should NEVER Treat Product Documentation as an Afterthought
Cover image for Why You Should NEVER Treat Product Documentation as an Afterthought

Why You Should NEVER Treat Product Documentation as an Afterthought

2
Comments 1
3 min read
Improving a Section That Caused Repeated Questions

Improving a Section That Caused Repeated Questions

Comments
1 min read
Correcting a Misleading Description of a Feature

Correcting a Misleading Description of a Feature

Comments
1 min read
Adding a Missing Step to the Devnet Walkthrough

Adding a Missing Step to the Devnet Walkthrough

Comments
1 min read
Making Testnet vs Devnet Usage Clearer

Making Testnet vs Devnet Usage Clearer

Comments
1 min read
LeafWiki Devlog #7: v0.6.1 - Introducing Backlinks + Better Search (SQLite FTS5) 🌿
Cover image for LeafWiki Devlog #7: v0.6.1 - Introducing Backlinks + Better Search (SQLite FTS5) 🌿

LeafWiki Devlog #7: v0.6.1 - Introducing Backlinks + Better Search (SQLite FTS5) 🌿

Comments
2 min read
How does API work? WHere's the manual?

How does API work? WHere's the manual?

Comments
3 min read
Documentation Is a Decision System, Not a Knowledge Base
Cover image for Documentation Is a Decision System, Not a Knowledge Base

Documentation Is a Decision System, Not a Knowledge Base

Comments
9 min read
Clarifying What Runs On-Chain vs Off-Chain

Clarifying What Runs On-Chain vs Off-Chain

Comments
1 min read
Improving a Tutorial That Failed During Testing

Improving a Tutorial That Failed During Testing

Comments
1 min read
Fixing a Misleading Diagram Description

Fixing a Misleading Diagram Description

Comments
1 min read
SpecMD — What if Your Documentation Was Your Code?
Cover image for SpecMD — What if Your Documentation Was Your Code?

SpecMD — What if Your Documentation Was Your Code?

Comments
2 min read
Your Code is a Liability: Why Documentation is the Only Asset That Matters
Cover image for Your Code is a Liability: Why Documentation is the Only Asset That Matters

Your Code is a Liability: Why Documentation is the Only Asset That Matters

Comments
4 min read
Adding a Missing Example for Privacy Controls

Adding a Missing Example for Privacy Controls

Comments
1 min read
Simplifying Technical Jargon in the Docs

Simplifying Technical Jargon in the Docs

Comments
1 min read
How to Write in Markdown but Deliver in Word. A Senior Architect's Workflow.
Cover image for How to Write in Markdown but Deliver in Word. A Senior Architect's Workflow.

How to Write in Markdown but Deliver in Word. A Senior Architect's Workflow.

Comments
2 min read
Fixing Broken Links in the Developer Resources

Fixing Broken Links in the Developer Resources

Comments
1 min read
Clarifying Zero Knowledge Proof Concepts

Clarifying Zero Knowledge Proof Concepts

Comments
1 min read
Automate Content Quality with VectorLint GitHub Action
Cover image for Automate Content Quality with VectorLint GitHub Action

Automate Content Quality with VectorLint GitHub Action

2
Comments 1
8 min read
Correcting a Code Example

Correcting a Code Example

Comments
1 min read
loading...