website icon indicating copy to clipboard operation
website copied to clipboard

Published 20 hours ago • verified publisher icon electron

feat: API History

Open piotrpdev opened this issue 7 months ago • 2 comments

[!NOTE] This PR is part of the 2024 Electron GSoC [Project] [Proposal].

Use export GH_TOKEN=<token> before yarn start if you want to test the releases fetching and unzipping.

You might have to manually modify sidebars.js to make yarn start work.

[!NOTE] In development mode, clicking on one of the breaking changes in the table will open the correct page but not jump to the linked header. This is an issue with Docusaurus.

  • https://github.com/facebook/docusaurus/issues/2399

TODO

  • Remove the changes to docs/api/*.md before merge, they're just for previewing/testing the PR.
    • https://github.com/electron/website/pull/594#discussion_r1666038994.
  • Remove the test data in src/transformers/api-history.ts https://github.com/electron/website/pull/594/files#diff-1150b9be07a8f0d779823f74f0403681feb5bc13bfda0a500edeadd81a8ce61cR94-R113
  • ~~Replace fetching the PR release versions artifact with fetching a JSON file once @dsanders11 implements that.~~ Won't happen for a while, will merge with GH_TOKEN.
    • https://github.com/electron/website/pull/586

piotrpdev avatar Jul 02 '24 17:07 piotrpdev