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.

Sign up for GitHub

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

Jump to bottom

Moved any valuable docs from jsdoc (/docs) into the SDK #5937

Merged
merged 7 commits into from
Jun 27, 2023
Merged

Moved any valuable docs from jsdoc (/docs) into the SDK #5937

merged 7 commits into from
Jun 27, 2023

Conversation

kraenhansen
Copy link
Member

@kraenhansen kraenhansen commented Jun 26, 2023 •
edited

What, How & Why?

I went through all the comments in /docs and moved all outstanding relevant comments into the SDK.

This closes #5575 by deleting the /docs directory, the docs/jsdoc-template submodule and all the jsdoc related workflows.

It also adds a lint:fix script to the root package and applies a few outstanding fixes to warnings that was introduced with the merge of #5779.

@kraenhansen kraenhansen self-assigned this Jun 26, 2023
@cla-bot cla-bot bot added the cla: yes label Jun 26, 2023
@kraenhansen kraenhansen mentioned this pull request Jun 27, 2023
Closed
@kraenhansen kraenhansen requested a review from kneth June 27, 2023 10:54
kneth
kneth approved these changes Jun 27, 2023
View reviewed changes
Copy link
Member

@kneth kneth left a comment

Choose a reason for hiding this comment

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

Please create an issue about recreating the GHA workflows

@kraenhansen kraenhansen mentioned this pull request Jun 27, 2023
Closed
@kraenhansen
Copy link
Member Author

I've created #5941 to track the (re)creation of the workflows.

takameyer
takameyer approved these changes Jun 27, 2023
View reviewed changes
Copy link
Contributor

@takameyer takameyer left a comment

Choose a reason for hiding this comment

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

Just a few NIT. Otherwise :shipit:

packages/realm/realm.node Outdated Show resolved Hide resolved
packages/realm/src/Collection.ts Show resolved Hide resolved
packages/realm/src/Collection.ts Show resolved Hide resolved
packages/realm/src/OrderedCollection.ts Outdated Show resolved Hide resolved
packages/realm/src/OrderedCollection.ts Outdated Show resolved Hide resolved
packages/realm/src/app-services/SyncConfiguration.ts Outdated Show resolved Hide resolved
packages/realm/src/bson.ts Outdated Show resolved Hide resolved
@kraenhansen kraenhansen force-pushed the kh/rm-jsdocs branch 3 times, most recently from 1f7e748 to 4869d25 Compare June 27, 2023 11:37
kraenhansen and others added 2 commits June 27, 2023 13:51
@kraenhansen @takameyer
Apply suggestions from code review
22562bd 
Co-authored-by: Andrew Meyer <andrew.meyer@mongodb.com>
@kraenhansen
Ranl lint:fix again.
5b570d7
@kraenhansen
Copy link
Member Author

Merging as the remaining failure is unrelated to the chances.

@kraenhansen kraenhansen merged commit b7ab83c into main Jun 27, 2023
33 of 34 checks passed
@kraenhansen kraenhansen deleted the kh/rm-jsdocs branch June 27, 2023 17:18
@kraenhansen kraenhansen mentioned this pull request Jul 14, 2023
Merged
11 tasks
@kraenhansen kraenhansen mentioned this pull request Nov 11, 2023
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@takameyer takameyer takameyer approved these changes

@kneth kneth kneth approved these changes

Assignees

@kraenhansen kraenhansen

Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove docs submodule from main
3 participants
@kraenhansen @takameyer @kneth