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

Documentation for existing components/features #2

Open
calummackervoy opened this issue Aug 3, 2021 · 2 comments
Open

Documentation for existing components/features #2

calummackervoy opened this issue Aug 3, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@calummackervoy
Copy link
Member

My suggestion:

  • set up a GitHub pages site for this repository
  • set up minimal documentation on the existing components/features exported by the library
@calummackervoy calummackervoy added the documentation Improvements or additions to documentation label Aug 3, 2021
@MattTennison
Copy link
Collaborator

There's https://storybook.js.org/ but it's very much focused on UI components and doesn't really have a good way of introducing the library as a whole.

MDX is a pretty neat (lets you use Markdown to write JSX) format, we could incorporate that into something custom using Gatsby but it could be time consuming to setup.

There's also https://docusaurus.io/ which, after a two minute scan through their website, seems to just let us write MDX files and it does all the heavy lifting.

@MattTennison
Copy link
Collaborator

The more I look at docusarus, the better it looks. Covers a bunch of key features that'd be a faff to write ourselves like searching, versioning and claims to be SEO-friendly. It's also being used by big projects like Jest so it might look and feel familiar to new developers.

Seems like the right choice for this stage in the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants