Skip to content

Expand per-utility documentation with theory sections and worked examples #118

Description

@YurMil

Turn the thin utility doc pages (docs/utilities/*.mdx) into self-sufficient reference articles: the underlying theory in plain language (what the standard computes and why), a step-by-step worked example with real numbers, common pitfalls, and a prominent link to run the calculation.

Prioritize by catalog popularity: Blind Flange, Dished End, Shell Rolling, Pipe Cutter, Thread Atlas first.

Why: engineers search for the calculation problem, not the tool name; a page that genuinely explains the calculation serves users better and is discoverable by exactly the audience the tool is for.

Acceptance criteria:

  • Top-5 utility doc pages rewritten to the article format
  • Each includes a worked example with numbers and units
  • Internal links between related tools' articles


This repo is using Opire - what does it mean? 👇
💵 Everyone can add rewards for this issue commenting /reward 100 (replace 100 with the amount).
🕵️‍♂️ If someone starts working on this issue to earn the rewards, they can comment /try to let everyone know!
🙌 And when they open the PR, they can comment /claim #118 either in the PR description or in a PR's comment.

🪙 Also, everyone can tip any user commenting /tip 20 @YurMil (replace 20 with the amount, and @YurMil with the user to tip).

📖 If you want to learn more, check out our documentation.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions