Skip to content

Rewrite the landing page and shrink the duplicated wsl/ install guide - #135

Merged
arhimede merged 2 commits into
alma-linux-10from
docs/fix-landing-page
Sep 25, 2026
Merged

arhimede merged 2 commits into
alma-linux-10from
docs/fix-landing-page

Conversation

@bidi47

@bidi47 bidi47 commented Sep 24, 2026

Copy link
Copy Markdown
Member
  • README.md (also served as docs/book/index.md via a symlink - it's
    simultaneously the MkDocs "Home" page and the GitHub-facing repo README)
    was stale v1-era content: duplicated the System Requirements page, had a
    "WLS2" typo, and linked to wsl/README.md via a path that resolves
    correctly on GitHub but not inside the built MkDocs site (the two
    contexts have different relative-path bases, since docs_dir is
    docs/book). Resolves FAQ: Add section for avatar upload related permission issues #18.
  • Replaced it with a short landing page: a "what you get" stack overview
    with a rough setup-time estimate (missing mariadb.repo file #25), an explanation of the v1
    (AlmaLinux 9) vs v2 (AlmaLinux 10) split (AlmaLinux9: Remove firewall-related commands #26), and getting-started
    links.
  • Because this file is rendered from two different physical locations, its
    links to the versioned docs use absolute docs.dotkernel.org URLs
    rather than relative paths - the only form that resolves correctly in
    both contexts.
  • wsl/README.md duplicated the full install walkthrough and had drifted
    (stale AlmaLinux-9 sample in its distro list, a stray period in the
    username example, passwd message wording that disagreed with the
    versioned docs). Shrunk it to a short pointer plus a link to the live
    installation page, so there's one source of truth
    (docs/book/v2/setup/installation.md) instead of two drifting copies.
    Resolves Issue #18: Added section for avatar upload related permission issues. #19.

README.md (also served as docs/book/index.md via symlink - it's the
MkDocs "Home" page and the GitHub-facing repo README at once) was
stale v1-era content: it duplicated the System Requirements page, had
a "WLS2" typo, and linked to wsl/README.md via a path that resolves
correctly on GitHub but not inside the built MkDocs site (the two
contexts have different relative-path bases, since docs_dir is
docs/book). Replaced it with a short landing page: a "what you get"
stack overview with a rough setup-time estimate, an explanation of the
v1 (AlmaLinux 9) vs v2 (AlmaLinux 10) split, and getting-started links.
Because this file is rendered from two different physical locations,
its links to the versioned docs use absolute docs.dotkernel.org URLs
rather than relative paths, which is the only form that resolves
correctly in both contexts.

wsl/README.md duplicated the full install walkthrough and had drifted
(stale AlmaLinux-9 sample in its distro list, a stray period in the
username example, passwd message wording that disagreed with the
versioned docs). Shrunk it to a short pointer at the folder's purpose
plus a link to the live installation page, so there's one source of
truth (docs/book/v2/setup/installation.md) instead of two drifting
copies.
@bidi47
bidi47 requested a review from arhimede September 24, 2026 15:50
Comment thread wsl/README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Signed-off-by: bidi <bidi@apidemia.com>
@arhimede
arhimede merged commit 6d85a71 into alma-linux-10 Sep 25, 2026
11 checks passed
@bidi47
bidi47 requested a review from arhimede September 25, 2026 11:16
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.

FAQ: Add section for avatar upload related permission issues

2 participants