Skip to content
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

blog: introducing api history #627

Merged
merged 16 commits into from
Aug 21, 2024
Merged

blog: introducing api history #627

merged 16 commits into from
Aug 21, 2024

Conversation

piotrpdev
Copy link
Collaborator

@electron/summer-of-code @dsanders11 @VerteDinde @erickzhao

@piotrpdev piotrpdev requested a review from a team as a code owner August 19, 2024 02:00
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 19, 2024 02:01 Inactive
@erickzhao erickzhao changed the title docs(blog): introducing api history blog: introducing api history Aug 19, 2024
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content-wise this looks great!

Comment on lines 165 to 171
Sadly, I couldn't think of a way to automate this effectively. This would probably
be a great task for an AI/ML engineer; however, I don't possess those skills and
was too afraid of accidentally introducing [hallucinations](<https://en.wikipedia.org/wiki/Hallucination_(artificial_intelligence)>)
into the API history. Even if automated, the information would still probably have
to be verified by a human in the end :/. This task will probably have to be done
manually, on a file-by-file basis,
[just like it was done for the Node.js documentation](https://github.com/nodejs/node/issues/6578).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should segue this section into a huge meta-issue that we can invite drive-by contributors to help edit. :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you elaborate? I'm not sure what you exactly have in mind.

Copy link
Member

@erickzhao erickzhao Aug 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should open an issue in electron/electron and have a call-to-action for folks to help out if they can, similar to the node.js one that was linked :)

blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 19, 2024 18:33 Inactive
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 19, 2024 18:45 Inactive
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
blog/introducing-api-history.md Outdated Show resolved Hide resolved
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:33 Inactive
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:34 Inactive
piotrpdev and others added 2 commits August 20, 2024 23:36
Co-authored-by: Erick Zhao <erick@hotmail.ca>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:36 Inactive
Co-authored-by: Erick Zhao <erick@hotmail.ca>
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:37 Inactive
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:41 Inactive
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 22:54 Inactive
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 20, 2024 23:00 Inactive
blog/authors.yml Outdated Show resolved Hide resolved
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 21, 2024 13:21 Inactive
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 21, 2024 13:22 Inactive
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-627 August 21, 2024 17:09 Inactive
@VerteDinde VerteDinde merged commit 267da8a into main Aug 21, 2024
4 checks passed
@VerteDinde VerteDinde deleted the docs/introducing-api-history branch August 21, 2024 17:16
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.

5 participants