fix(docs/upload): add safeguard if projects have bidi enabled #1175
Conversation
This file contains 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
emilyskuo
changed the title
kanadgupta
requested changes
Mar 3, 2025
src/lib/types.ts
Outdated
There was a problem hiding this comment.
😮💨 do you think we could make it so we split out the openapi changes into their own PR? and this PR is branched off of that PR?
There was a problem hiding this comment.
New branch here for the openapi changes! #1195
kanadgupta
added a commit
that referenced
this pull request
Mar 7, 2025
## 🧰 Changes this PR updates our APIv2 openapi description as part of @emilyskuo's work in #1175 and chunks out the OAS into its own dedicated file since it's absolutely massive. you can check out the diff of the file changes [here](next...1346b8b). i tried messing around with JSON module imports so we can eventually automate these updates more easily, but we lose out on a lot of good strict typing that we currently have with `as const satisfies OASDocument`. annoying! ## 🧬 QA & Testing no functional changes. do tests still pass?
…pload-for-users-that-have-bidi
Co-authored-by: Kanad Gupta <[email protected]>
emilyskuo
commented
Mar 11, 2025
| @@ -3245,6 +3245,21 @@ const document = { | |||
| description: | |||
| 'The description of your project. This is used in the page meta description and is seen by search engines and sites like Facebook.', | |||
| }, | |||
| git: { | |||
There was a problem hiding this comment.
Temporarily adding this in manually instead of generating the doc again - will do that once https://github.com/readmeio/readme/pull/13869 is good and merged
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.
🧰 Changes
Adding in a safe guard for ReadMe projects with bidirectional sync enabled, since the docs frontmatter format is different for bidi. By default,
rdme docs uploadmay try to "fix" things and modify the markdown files, which could result in corrupted data and/or syncing errors.Once https://github.com/readmeio/readme/pull/13869 is merged, we'll be exposing info on the project's bidi connection if it exists via the get project metadata (
/projects/me) endpoint. This PR will introduce a check to see if a bidi connection exists, and throw an error if it does. If users want to continue uploading viardme, they can use the--skip-validationflag to do so without potential issues fromrdme's validation & fixing steps.🧬 QA & Testing
Tested this against https://github.com/readmeio/readme/pull/13869 locally. Added some tests for
docs uploadas well.