Created components for documentation pages and refactored documentation to use the components - #933
Open
BboyAkers wants to merge 4 commits into
Open
Created components for documentation pages and refactored documentation to use the components#933BboyAkers wants to merge 4 commits into
BboyAkers wants to merge 4 commits into
Conversation
Contributor
Author
|
@julien-moreau Thoughts/honest feedback on my changes? 🙂 |
Contributor
|
Hey @BboyAkers !! This is awesome !!!! Way more professional and way more readable !! I’m verifying the content right now and I like the components you created. Thanks a lot I already noticed that « using sprite manager » page is not working. If you can fix this that would be great :) im continuing my review |
Contributor
Author
|
Absolutely! Sorry about that haha 😅 |
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.
Componentized and simplified the documentation pages
Summary/Benefits
I created and simplified the documentation by creating components for commonly used elements and sections. While everything is done by hand, this should make creating and modifying pages in the documentation much easier.
The collection of reusable documentation components are under
website/src/app/documentation/components/:<DocPage/>: Replaces repeated<main>wrappers and manual animations. Dynamically extracts page titles and descriptions from route configuration, standardizes container widths/margins, and automatically handles route transitions and footer pagination.<DocHeading/>: Standardizes heading levels (h2, h3, h4) and automatically slugifies heading text (even when containing child JSX nodes) to provide hoverable deep-link anchor tags (#slug).<Callout/>: Replaces raw warning/info divs with styled alert boxes supporting multiple variants (note, info, tip, warning, caution, success) using lucide-react icons.<DocVideo/>&<DocImage/>Provides consistent wrappers for media assets with rounded borders, responsive aspect ratios, and optional caption support (<figcaption>).<DocPagination/>: Automatically computes and renders "Previous" and "Next" navigation cards at the bottom of pages, replacing the deleted manual<NextChapterComponent/>.Sidenote
I wanted to refactor the documentation to use Docusaurus, but I felt it would be a radical change and was unsure whether you all would like that. So this was an alternative that built upon what was already there. Would love to know your thoughts!!! Please feel free to critique my code changes. I personally want to make documentation creation much easier for ya'll