-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: API History #594
feat: API History #594
Conversation
Reported-by: David Sanders <dsanders11@ucsbalum.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a couple of suggestions to simplify the code.
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
Co-authored-by: David Sanders <dsanders11@ucsbalum.com> Based-on-patch-by: David Sanders <dsanders11@ucsbalum.com> Reference: #594 (comment)
I think this is ready. 🎉 @piotrpdev, can you go ahead and remove the |
`git diff feat/api-history origin/main -- docs/latest/api/ | git apply`
Done, hopefully nothing breaks on merge 🤞 |
Note
This PR is part of the 2024 Electron GSoC [Project] [Proposal].
Use
export GH_TOKEN=<token>
beforeyarn start
if you want to test the releases fetching and unzipping.You might have to manually modify
sidebars.js
to makeyarn 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.
TODO
docs/api/*.md
before merge, they're just for previewing/testing the PR.src/transformers/api-history.ts
https://github.com/electron/website/pull/594/files#diff-1150b9be07a8f0d779823f74f0403681feb5bc13bfda0a500edeadd81a8ce61cR94-R113Replace fetching the PR release versions artifact with fetching a JSON file once @dsanders11 implements that.Won't happen for a while, will merge withGH_TOKEN
.