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

docs: Add docusaurus website #74

Merged
merged 12 commits into from
Dec 11, 2018

Conversation

brooksbecton
Copy link
Contributor

@brooksbecton brooksbecton commented Nov 27, 2018

Summary

Add docusaurus website under the /docs folder

Relates to #26

Copy link
Member

@thymikee thymikee left a comment

Choose a reason for hiding this comment

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

This is awesome! For now let's not focus on colors/designs, I just want this to be available so we can steadily iterate on the shape of the website. Please address the comments I made and remove any unnecessary code

docs/docs/api.md Outdated
@@ -0,0 +1,346 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

Once you rebase to master, you should be good to remove the docs/docs directory and use what's there already

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it may have to live in a folder. We can rename it to a custom folder though.
https://docusaurus.io/docs/en/site-config#customdocspath-string

Do you know if there is a another way to do it like ya'll want?

Copy link
Member

@thymikee thymikee Nov 29, 2018

Choose a reason for hiding this comment

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

Seeing how we do stuff at Jest repository, how about having this:

docs/
  api.md
website/
  docusaurus taking stuff from `docs/`
...rest

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've moved it around. Can you take a look?

@@ -0,0 +1,214 @@
/**
Copy link
Member

@thymikee thymikee Nov 27, 2018

Choose a reason for hiding this comment

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

We'd like this page to be as simple as possible. Like this one: https://linaria.now.sh/. Feel free to discard this comment though, we first need to design it :D. But would be cool if you could remove all the unnecessary stuff and render only HomeSplash

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've commented out the other sections and left in a link the example.md

It now has the website title, slogan, logo, and a button link to an example

Copy link
Member

Choose a reason for hiding this comment

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

Would be even better if you removed this code, it's gonna be deleted anyway :)

docs/website/siteConfig.js Outdated Show resolved Hide resolved
docs/website/siteConfig.js Outdated Show resolved Hide resolved
docs/website/siteConfig.js Outdated Show resolved Hide resolved
docs/website/siteConfig.js Outdated Show resolved Hide resolved
@thymikee
Copy link
Member

Can we get rid of package-lock.json? We use yarn in this repo, so it would be preferred to have yarn.lock

brooksbecton and others added 4 commits December 1, 2018 11:38
* origin/master:
  chore: Update flow-bin to the latest version 🚀 (callstack#86)
  chore: Greenkeeper/@types/react 16.7.11 (callstack#82)
  chore: release 1.4.2
  fix: add errors for queryBy* helpers when more instances found (callstack#79)
  chore: release 1.4.1
  chore: release 1.4.1-es5.1
  fix: remove deprecated existential Flow type and use any for now (callstack#77)
  docs: add note about new APIs in v1.4 (callstack#76)
  chore: Update flow-bin to the latest version 🚀 (callstack#75)
@thymikee thymikee changed the title [WIP] Add docusaurus website docs: Add docusaurus website Dec 11, 2018
@thymikee thymikee closed this Dec 11, 2018
@thymikee thymikee reopened this Dec 11, 2018
@thymikee thymikee changed the base branch from master to expo-bug/flatlist December 11, 2018 18:55
@thymikee thymikee changed the base branch from expo-bug/flatlist to master December 11, 2018 18:55
@thymikee
Copy link
Member

Not sure why CI doesn't kick in, but I think we can get merge it in current shape. Thanks a lot for starting it @brooksbecton! We'll need to tweak the page a little bit more and soon we'll publish it :)

@thymikee thymikee merged commit ad61c40 into callstack:master Dec 11, 2018
@brooksbecton brooksbecton deleted the Add_Docusaurus_Website branch December 11, 2018 20:23
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.

None yet

3 participants