Skip to content

Profile README: README standard, link the portal - #8

Merged
N3b3x merged 3 commits into
mainfrom
docs/profile-portal
Nov 2, 2026
Merged

N3b3x merged 3 commits into
mainfrom
docs/profile-portal

Conversation

@N3b3x

@N3b3x N3b3x commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Rewrites the organisation profile to the README standard in hf-general-ci-tools' DOCS-STYLE-GUIDE.md and points it at the new portal (hardfoc/hardfoc.github.io#6).

Profile (profile/README.md)

  • A hero line, then the portal link in bold.
  • One diagram: the layer graph (drivers, then core, then HALs, then products). The submodule detail is unchanged.
  • "What is here" in five bullets: the two boards, portable chip drivers, the shared core, board HALs, shared CI and docs.
  • A table of the six most useful pages: Get started, Repositories, Architecture, the two HAL sites, CI tools.
  • Contributing, code of conduct, the private vulnerability report and discussions.
  • The full repository tables are gone. The portal's catalogue lists every public repository with its docs and latest release, generated from org/org-metadata.json and the GitHub API, so the profile no longer has a hand-kept copy that drifts.

Repository README

README.md was two words. It now says what the repository holds (profile, community defaults, templates, org/ metadata and scripts) and links the portal.

Before merge

The portal links (https://hardfoc.github.io/get-started/ and the others) resolve once hardfoc/hardfoc.github.io#6 is merged, deployed, and Pages is switched to gh-pages. Until then they 404, because Pages still serves the old placeholder site from main. Merge this after that switch.

@N3b3x
N3b3x merged commit 5b23027 into main Nov 2, 2026
@N3b3x
N3b3x deleted the docs/profile-portal branch November 2, 2026 13:26
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