Skip to content

docs: import documentation from electron-forge-docs - #4345

Draft
erickzhao wants to merge 3 commits into
nextfrom
docs-import
Draft

docs: import documentation from electron-forge-docs#4345
erickzhao wants to merge 3 commits into
nextfrom
docs-import

Conversation

@erickzhao

Copy link
Copy Markdown
Member

Imports the v6 branch of electron-forge-docs into docs/, converted from GitBook syntax to Docusaurus-compatible Markdown/MDX. No page content was rewritten — only syntax and the formatting needed to satisfy this repo's markdown lint rules.

Conversions

GitBook Docusaurus
{% hint style=info/warning/danger/success %} :::info / :::warning / :::danger / :::tip
{% code title="x" %}, <pre class="language-x" data-title> fence metadata (title="x", {1,8} line highlighting)
{% tabs %} / {% tab %} <Tabs> / <TabItem>
{% content-ref %} inline Markdown links
<table data-view="cards"> link lists
<figure> / <figcaption> JSX
"mention" links resolved to the target page's title
.gitbook/assets/* docs/static/img/*
.gitbook/includes/* docs/_partials/*.mdx (used by the DMG maker and S3 publisher docs)
README.md index.md
SUMMARY.md generated docs/sidebars.ts

Files that need JSX or MDX comments use .mdx (12 of 57).

Freeing up docs/

docs/ was already typedoc's default output directory — gitignored, excluded from oxlint/oxfmt, and published to js.electronforge.io. The first commit retargets that generated output to api-docs/:

  • typedoc.json: "out": "api-docs"
  • .gitignore / .oxlintrc.json: docsapi-docs
  • .github/workflows/gh-pages.yml: docsPath: api-docs

Verification

  • Builds clean against Docusaurus 3.10.2 with onBrokenLinks, onBrokenMarkdownLinks, and onBrokenAnchors all set to throw.
  • yarn lint:markdown, lint:markdown-js, lint:markdown-links, oxlint, and oxfmt --check all pass repo-wide.
  • A prose diff against the original v6 tree shows only the expected syntax-level differences.

Notes for reviewers

  • Two link anchors were corrected because their targets can't be expressed as Docusaurus heading ids: cli.md#Init#init, and the dotted #open-source-apps-update.electronjs.org#open-source-apps-updateelectronjsorg.
  • Formatting-only fixes for this repo's lint rules: 22 collapsed double blank lines, 5 blank lines added before ::: after a closing fence, 3 bare fences tagged text, and one mis-indented makers block in create-and-add-icons.md corrected by lint-roller-markdown-standard --fix.
  • The docs repo's own .github/workflows/, .markdownlint.json, and .markdownlintignore were dropped in favour of this repo's root config.
  • The 12 .mdx files are not matched by the **/*.md lint globs, so they're currently unlinted. Worth a follow-up.
  • No site scaffolding (docusaurus.config.ts, package.json, theme) is included yet — sidebars.ts assumes the docs are the site's docs root.
  • yarn docs should be run once to confirm typedoc output lands in api-docs/; only the config wiring has been verified.

🤖 Generated with Claude Code

erickzhao and others added 2 commits August 17, 2026 12:49
Frees up the `docs/` directory for the human-authored documentation being
imported from electron-forge-docs. The generated typedoc output moves to
`api-docs/`, which stays gitignored and excluded from oxlint/oxfmt; the
gh-pages workflow points at the new path via `docsPath`.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Imports the v6 branch of electron-forge-docs into `docs/`, converted from
GitBook syntax to Docusaurus-compatible Markdown/MDX:

- `{% hint %}` blocks become `:::info` / `:::warning` / `:::danger` / `:::tip`
- `{% code %}` and `<pre>` wrappers become fence metadata (`title=`, `{1,8}`)
- `{% tabs %}` becomes `<Tabs>` / `<TabItem>`, `{% content-ref %}` becomes links
- card tables become link lists, `<figure>` becomes JSX
- `.gitbook/assets` moves to `static/img`, the shared include becomes an MDX
  partial in `_partials/` used by the DMG maker and S3 publisher docs
- `README.md` files become `index.md`; files needing JSX or MDX comments use
  `.mdx`
- `SUMMARY.md` becomes a generated `sidebars.ts`

Page content is unchanged apart from formatting needed to satisfy this repo's
markdown lint rules. Two link anchors were corrected because their targets
could not be expressed as Docusaurus heading ids (`cli.md#Init` and the
dotted `#open-source-apps-update.electronjs.org`).

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@github-actions github-actions Bot added the next label Aug 17, 2026
Transcribes the hand-drawn build lifecycle diagram
(Untitled-2022-08-26-1442 (1).png) into the Mermaid graph in
core-concepts/build-lifecycle.md, which previously held a simplified
version of the same flow. The Mermaid version adds the artifact labels on
each edge and the dashed "depends on" edges that show the cascading build
steps, and drops the leftover GitBook `fullWidth="false"` fence attribute.

The PNG was an unreferenced draft asset, so it is deleted rather than
replaced in place.

Note that rendering this requires `@docusaurus/theme-mermaid` and
`markdown.mermaid: true` in the eventual site config.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant