-
Notifications
You must be signed in to change notification settings - Fork 20
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
Add docs site #73
Add docs site #73
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks awesome, just one comment below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm super excited about this! When we start making changes to this later, I imagine we'll need to gh pr checkout
each PR to see what the rendered markdown looks like each time?
@@ -0,0 +1,3 @@ | |||
# Code sandbox | |||
|
|||
If you want to play around with unit testing without installing or bootstrapping a project, [here's a code sandbox template](https://codesandbox.io/s/roku-unit-testing-16c26?file=/tests/source/utils.test.brs) you can use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's involved in updating the sandbox? I imagine we'll need to change that one day. Is it a codepen kind of thing where the URL includes a hash of the source, and if the sources change we just update the URL here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm not quite a hash, I don't think. The base link wouldn't change if the sandbox gets updated, but the url parameter with the file name might need to change if the file got removed. I only added that parameter because I thought it was a nicer entry point than the default package.json
, but we can always change it 🤷♂️
Yeah, most likely. I mean, looking at the "raw" markdown is also reasonable enough if it's a small change -- docsify just takes markdown and styles it in a more attractive way. |
aea13d9
to
e64a60c
Compare
Change summary
This adds a docs folder to be powered by docsify and deployed via Github pages. I realize this is a ton of changes to review. Almost all of it was copied over from this README and the
brs
README.For reviewing, I highly recommend you run this code locally (
npx docsify serve ./docs
) and view the site that way, it'll be much easier than going through the raw files in this PR 😅There are a couple empty pages with
TODO
s in this PR -- they're placeholders for pages that I think we should write in the future at some point.