docs: import documentation from electron-forge-docs - #4345
Draft
erickzhao wants to merge 3 commits into
Draft
Conversation
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>
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Imports the
v6branch of electron-forge-docs intodocs/, 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
{% hint style=info/warning/danger/success %}:::info/:::warning/:::danger/:::tip{% code title="x" %},<pre class="language-x" data-title>title="x",{1,8}line highlighting){% tabs %}/{% tab %}<Tabs>/<TabItem>{% content-ref %}<table data-view="cards"><figure>/<figcaption>"mention"links.gitbook/assets/*docs/static/img/*.gitbook/includes/*docs/_partials/*.mdx(used by the DMG maker and S3 publisher docs)README.mdindex.mdSUMMARY.mddocs/sidebars.tsFiles 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 toapi-docs/:typedoc.json:"out": "api-docs".gitignore/.oxlintrc.json:docs→api-docs.github/workflows/gh-pages.yml:docsPath: api-docsVerification
onBrokenLinks,onBrokenMarkdownLinks, andonBrokenAnchorsall set tothrow.yarn lint:markdown,lint:markdown-js,lint:markdown-links,oxlint, andoxfmt --checkall pass repo-wide.Notes for reviewers
cli.md#Init→#init, and the dotted#open-source-apps-update.electronjs.org→#open-source-apps-updateelectronjsorg.:::after a closing fence, 3 bare fences taggedtext, and one mis-indentedmakersblock increate-and-add-icons.mdcorrected bylint-roller-markdown-standard --fix..github/workflows/,.markdownlint.json, and.markdownlintignorewere dropped in favour of this repo's root config..mdxfiles are not matched by the**/*.mdlint globs, so they're currently unlinted. Worth a follow-up.docusaurus.config.ts,package.json, theme) is included yet —sidebars.tsassumes the docs are the site's docs root.yarn docsshould be run once to confirm typedoc output lands inapi-docs/; only the config wiring has been verified.🤖 Generated with Claude Code