Skip to content

docs(readme): trim duplicated Quick Start content, fold details into Usage#45

Merged
MudDev merged 1 commit into
mainfrom
docs/readme-trim-duplication
May 19, 2026
Merged

docs(readme): trim duplicated Quick Start content, fold details into Usage#45
MudDev merged 1 commit into
mainfrom
docs/readme-trim-duplication

Conversation

@MudDev
Copy link
Copy Markdown

@MudDev MudDev commented May 19, 2026

Summary

Supersedes #44. @slrslr correctly observed that step 5 of Linux Installation ("Access the dashboard") and the "Creating Your First Site" walkthrough duplicate content already covered in ## Usage below. This PR applies that removal and ties up two loose ends raised in review.

Changes

Same as #44

  • Removes step 5 ("Access the dashboard") from Linux Installation
  • Removes the entire ### Creating Your First Site walkthrough
  • Adds a "Publish changes" bullet to Site Management

Additional fixes

  1. Preserve sole-ownership detail. The deleted step 3 said "you'll be redirected to your new site that only you can modify" — the one piece of information from the walkthrough not duplicated elsewhere. Folded into the Site Management bullet:

    - - **Create new site**: Dashboard → ⋮ → "Create new, empty site"
    + - **Create new site**: Dashboard → ⋮ → "Create new, empty site" — you become the sole owner and only you can modify it
  2. Drop the now-stale jump-to anchor. The jump block added in docs(readme): add Quick Start jump block, label OS-specific install sections #36 included [first site](#creating-your-first-site). With the section gone, that anchor breaks. Updated to:

    - > - **Post-installation:** [first site](#creating-your-first-site) | [configuration](#configuration) | [usage](#usage)
    + > - **Post-installation:** [configuration](#configuration) | [usage](#usage)

Verification

  • -13/+3 net, scoped to README.md
  • All remaining jump-to anchors in the > [!NOTE] block still resolve (#linux-installation, #docker-installation, #convenience-scripts, #windows-installation, #configuration, #usage)
  • No information from the deleted walkthrough is lost — covered either by Usage/Site Management or folded into the new bullets above

Credit

@slrslr in #44 for the scope-reduction observation.

…Usage

slrslr (#44) correctly observed that step 5 of Linux Installation
("Access the dashboard") and the "Creating Your First Site" walkthrough
duplicate content already covered in the Usage section below. This
commit applies that removal and ties up two loose ends:

- Site Management's "Create new site" bullet now mentions sole
  ownership ("you become the sole owner and only you can modify it"),
  preserving the one piece of information not previously duplicated
  elsewhere (the deleted step 3).
- Site Management adds a "Publish changes" bullet describing the
  drag-and-sign flow.
- Jump-to block at line 41 drops the now-stale
  #creating-your-first-site anchor.

Supersedes #44 by keeping its scope-reduction intent and adding the
two small fixes raised in review.
@MudDev MudDev mentioned this pull request May 19, 2026
@MudDev MudDev merged commit b4c0963 into main May 19, 2026
@MudDev MudDev deleted the docs/readme-trim-duplication branch May 19, 2026 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant