Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip - playing with a keystatic-based examples explorer #9285

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kennedybaird
Copy link
Contributor

This is an idea for managing part of the examples with keystatic (just a rough quick example).

It would use/manage the README.md file for each example and adds the ability to define a preview file, and select related docs.

It has some important notes:

  1. It needs to add a .yaml file in each dir - which could be confusing for end users (side note: maybe those files should have a commented #keystatic file at the start of them?)
  2. The examples would need to move to docs/examples as keystatic can't access the dir above (or keystatic needs to move to the project root, but I don't think that's appropriate)

What I like about this:

  • allows to customise the examples viewing experience on the website, whilst respecting the example files as the main source of truth
  • selecting related docs seems useful
  • using tags could allow for building a more robust explorer

image

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit efe6b52:

Sandbox Source
@keystone-6/sandbox Configuration

@kennedybaird
Copy link
Contributor Author

@simonswiss - I'd love to keep playing with this idea, but will save putting time in until there's some feedback. Hope you can take a glance this week 🙏

@kennedybaird
Copy link
Contributor Author

I'd still be interested in following through with this - if it's a no go then I would go back to transitioning all the examples to the new codesandbox approach so that they're at least working.

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.

1 participant