Skip to content

[FEATURE]: Documentation + Demos with Docusaurus - #134

Open
pravton wants to merge 81 commits into
mainfrom
feature/docs-and-demos
Open

pravton wants to merge 81 commits into
mainfrom
feature/docs-and-demos

Conversation

@pravton

@pravton pravton commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Description

Time tracking task: https://wethecollective.teamwork.com/app/tasks/26870530

This PR adds Docusaurus for managing documentation and the public demos so we could have like one place to see all gallery related demos consumes this package.

The goal is to create one demo file docs/src/components/demos and the docs in docs/docs/demos, everything else will be handled for you, including typescript / js conversion on the demo with script file that handles the conversion.

Hopefully this will be useful until we slowly migrate over to the Gordito Gallery.

Additional details

  • Added a hook get the version installed and using that across the docs so we have one source of truth and eliminating mismatched versions on the doc.
  • Adds API docs based on the README.
  • Adds best practices guides talks about styling, accessibly and typescript.
  • Added few demos with examples.
  • Versioning derived from the installed package which helps us to keep the versioning consistent.
  • A button option to try and edit these demos on Code pen.
  • Updated the root package json with docs related commands.
  • Added a workflow file for the github pages deployment, but the projects settings still need to be updated.

Usage

rm -rf node_modules docs/node_modules
npm install
npm run docs:start

Notes

Used Gemini & Claude models for helping out with docs and file conversion script etc.

@andrewrubin andrewrubin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay! All of my earlier changes are addressed, except the issue of repeated content. Let's think about that one. Happy to chat through it.

@pravton
pravton requested a review from andrewrubin November 16, 2026 23:12
@pravton

pravton commented Nov 16, 2026

Copy link
Copy Markdown
Contributor Author

This is looking great Clinton! Had a scan through the demos and had a couple small comments. Also some general observations:

Looks like Gallery is missing in the below sentence, or am I missing something?

I'm wondering if we have some kind of visual indicator appear on focus for the next/previous buttons on the stories gallery. The alt text makes sense, but right now it kind of looks like nothing is bring focussed. What do you reckon?

stories-gallery.mp4

I think the current focus ring on hidden button is sufficient for this demo though, and anything more feels like too opinionated for me but let me know if you have anything in mind how we could update this.

Comment thread docs/snippets/gallery-css-props.mdx Resolved
Comment thread docs/docs/api/gallery-item.md Resolved
@pravton
pravton requested a review from andrewrubin November 17, 2026 16:33
@andrewrubin

andrewrubin commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Oops, I forgot one thing here @pravton: can we remove the X/Twitter link in the footer? That account hasn't been used since 2023, looks like. We shouldn't encourage people to go there 😂 Maybe Instagram instead since that's active? And/or LinkedIn?

@andrewrubin

andrewrubin commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Let's also get the header to be consistent with the other @wethegit packages such as https://wethegit.github.io/react-hooks/ (use the WTC logo, etc.)

@pravton

pravton commented Nov 18, 2026

Copy link
Copy Markdown
Contributor Author

Let's also get the header to be consistent with the other @wethegit packages such as https://wethegit.github.io/react-hooks/ (use the WTC logo, etc.)

Thanks, I updated this!

@pravton

pravton commented Nov 18, 2026

Copy link
Copy Markdown
Contributor Author

Oops, I forgot one thing here @pravton: can we remove the X/Twitter link in the footer? That account hasn't been used since 2023, looks like. We shouldn't encourage people to go there 😂 Maybe Instagram instead since that's active? And/or LinkedIn?

Thanks, yeah I have also removed x, added instagram and LinkedIn. I have also merged main and updated the header to render the latest version and the link.

@andrewrubin andrewrubin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is looking great ✨ I think we're ready to get this merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants