Rewrite generate-errors and improve learn/errors
#1089
Merged
Conversation
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
This allows for getting the content of the error pages for use in the Zola pages.
It felt more appropriate for this specific tool to be more like the book or migration guides in how it's formatted. Would be more readable and searchable as well.
The original markdown files already have a title, but Zola will ad its own, so it was creating duplicate level one headers for the title which looked wrong.
The prior URL now redirects to the proper page causing an odd white flash briefly. This minimizes this by putting the proper link instead.
That way they're not littering useless folders on the user's system.
We now use the docs-section and docs-page template, so the old errors template is now vestigial and can be deleted.
Decided that output_path and errors_path made more sense than content_path and bevy_repo_path.
TrialDragon
added
C-Feature
Not sure if this is an actual typo, but I think it reads better.
Noticed an area which could get confusing without context. Also figured stuff should be capitalized for readability.
BD103
reviewed
Mar 11, 2024
BD103
suggested changes
Mar 11, 2024
Member
There was a problem hiding this comment.
Good work, this is definitely needed!
This seems to break syntax highlighting in the generated pages. I believe it's due to should_panic and the order of the code block attributes.
Generated with your branch, broken:
```rust,should_panic
Generated with main, works:
```rust
You can also fix it by making rust last:
```should_panic,rust
Member
Author
|
Ah, I see. The old solution just thru away the info, it just needs to be reordered. I'll fix that later. |
TrialDragon
commented
Mar 11, 2024
Member
Author
TrialDragon
left a comment
TrialDragon
left a comment
There was a problem hiding this comment.
Personal notes questioning yesterday's me's decisions.
I keep confusing assets with errors mentally; this is just the one I didn't catch before commit.
It's simpler than the odd way I was doing it before.
Before it was in an invalid ordering where annotations were added after the language.
alice-i-cecile
approved these changes
Mar 16, 2024
BD103
suggested changes
Mar 16, 2024
Co-authored-by: BD103 <[email protected]>
Co-authored-by: BD103 <[email protected]>
Co-authored-by: BD103 <[email protected]>
Co-authored-by: BD103 <[email protected]>
Co-authored-by: BD103 <[email protected]>
Forgot to import the macro when it was added.
Before they relied on the same folder which could be deleted in the middle of one test by another. Now they use different folders to avoid stepping on each others toes.
These ones don't need formatting, so it's safe to make them constant.
BD103
approved these changes
Mar 18, 2024
Member
BD103
left a comment
BD103
left a comment
There was a problem hiding this comment.
Please update the .gitignore for the separate content folders, but beyond that it looks good!
Co-authored-by: BD103 <[email protected]>
alice-i-cecile
added
the
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Part of #789 and touches #1059
This removes the use of invalid pages the
learn/errorssection had and stops using a section as a page which is bad practice.Now
learn/errorsuses thedocs-*templates and is more like the book or migration guides or quick start guide. This feels better imo since you don't have to scroll one long page to find your specific error; you now have specific pages for errors.I ended up rewriting the whole
generate-errorstool because the old one was poorly documented, seemingly esoteric / maybe over-engineered in it's ways of doing things making it hard to work on, and just a bit hard to retrofit to work as adocs-*based page rather than the bad practice section as a page.Tl:dr: Was easier to rewrite than fix the old.
At least it has documentation now. (Speaking of which please mention anywhere the documentation may be lacking; I don't want this to be hard to work with in the future potentially).