Conversation
|
|
11 tasks
a5923a6 to
9d64b6d
Compare
Contributor
PR SummaryThis PR introduces a number of documentation enhancements that detail new functionality in the project. The major changes include:
These changes enhance the clarity and guidance provided in the docs and introduce new content that reflects the extended functionality of the software. Test Suggestions
|
This file contains hidden or 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
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.
Pull Request Description
What and why?
After a wild goose chase of trying to figure out why we were missing newer Python API files in our output, I figured it out: we had added the
*.qmdfiles to the.ignoreduring a recent PR review, because we expect a GitHub workflow to generate and commit the files.After doing a bit of research, GitHub workflows also respect the
.gitignoreand so this addition not only affects what gets committed locally but would also break our workflow, if it wasn't broken already.That's it, this is the sum total of our problems. Removed 1 line, regenerated the files, and all is well. Took some serious head-scratching until the penny dropped, though, as I expected there to be a complicated problem and started digging deep. The final clue was this differently colored file in Cursor:
Relates to:
How to test
Check the preview: LIVE PREVIEW
Before
After
What needs special review?
Dependencies, breaking changes, and deployment notes
Release notes
Checklist