Write a basic README #111
Write a basic README #111
Conversation
There was a problem hiding this comment.
Also, I think we can create a major to-do list for us as well as others to know. One is we want everything documented in our example docs. I started documenting the features I added later https://gatsby-theme-iterative-example.herokuapp.com/doc/examples.
I am approving so that we can have this repo made public asap. We can always improve more on follow-up.
| [Iterative](https://iterative.ai). This package is currently purpose-built | ||
| specifically for our websites and not very useful outside of them, but we intend | ||
| to change that as we make improvements and iron out issues! |
There was a problem hiding this comment.
Let's clear our main purpose here of providing a reusable package for easily creating documentation, sharing reusable components, utility functions, etc. This will clear our goal as well. We can write a disclaimer as well.
| ### Examples | ||
|
|
||
| See this example from | ||
| [the example website's `gatsby-config.js`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/example/gatsby-config.js). |
There was a problem hiding this comment.
I think example usage should include installation
yarn add @dvcorg/gatsby-theme-iterative
and using the theme as a package itself once we make this public we expect others to try it out as a package.
|
Great points, and thanks for the quick approval! This was very much just a last minute "get the minimum to go public asap" up without regard to any way a consumer could use them, considering I doubt anyone but us will for a while. I'll get to work on a follow-up tomorrow amending with your suggestions. |
|
I wonder why the deploy didn't link up to this PR? One was made on Heroku, but it's only accessible via the UI. We'll have to keep this in mind in case it happens again in another PR. |
This basic README is written in anticipation of open-sourcing this repo. IMO we don't need anything fancy, especially with the project's APIs being so heavily in flux. For example, #33 will remove most of the PostCSS options mentioned here, as well as a lot of layout wrapper stuff that will greatly simplify and change how the theme is consumed.