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

Convert our GitHub docs to MDX in Next.js #290

Closed
cindyorangis opened this issue Nov 20, 2019 · 11 comments · Fixed by #2853
Closed

Convert our GitHub docs to MDX in Next.js #290

cindyorangis opened this issue Nov 20, 2019 · 11 comments · Fixed by #2853
Labels
type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority

Comments

@cindyorangis
Copy link
Contributor

docusaurus is a neat way to organize and maintain markdown docs. It's used in many Facebook repositories and I think we could totally implement it in our project as well.

Here is an example from create-react-app:

All of their markdown documents show up like
Annotation 2019-11-19 215306

https://create-react-app.dev/docs/getting-started

@cindyorangis cindyorangis self-assigned this Nov 20, 2019
@cindyorangis
Copy link
Contributor Author

@seanprashad you're not on the assignees list for some reason so I'm tagging you here

@humphd
Copy link
Contributor

humphd commented Nov 20, 2019

Sent @seanprashad an invite to be a collaborator on the repo.

@seanprashad seanprashad self-assigned this Nov 20, 2019
@seanprashad seanprashad added the type: documentation (docs) Improvements or additions to documentation label Nov 20, 2019
@lozinska lozinska added Priority: Low type: nice to have Feature that'd be nice to have, but not a priority labels Jan 27, 2020
@cindyorangis
Copy link
Contributor Author

Mentioned by @humphd a while ago that this can be achieved using Gatsby as well.
https://www.gatsbyjs.org/docs/adding-markdown-pages/

I will likely morph this into Gatsby markdown pages in the future instead of implementing docusaurus.

@c3ho
Copy link
Contributor

c3ho commented Mar 2, 2020

Let's leave this for post 1.0

@cindyorangis cindyorangis mentioned this issue Mar 6, 2020
@cindyorangis cindyorangis changed the title Implement docusaurus for our markdown documents Implement Gatsby Markdown Pages for our developer documents Mar 9, 2020
@cindyorangis
Copy link
Contributor Author

Find something similar to this https://material-ui.com/components/tabs/ for Gatsby...
Idea: have this kind of set up for installation instructions for each OS

[Linux][Mac][Windows]

[instructions... ]

@seanprashad seanprashad removed their assignment Jul 23, 2020
@humphd humphd changed the title Implement Gatsby Markdown Pages for our developer documents Convert our GitHub docs to MDX in Next.js Jan 22, 2021
@humphd
Copy link
Contributor

humphd commented Jan 22, 2021

Morph this into a bug about doing the same thing in next.js. cc @chrispinkney, related to #1463 for followup.

@cindyorangis
Copy link
Contributor Author

Once #1463 gets resolved, I'd like to progress forward with this. After so many morphs, I think MDX with Next.js will be the one to actually get implemented.

https://nextjs.org/blog/markdown looks promising.

@izhuravlev
Copy link
Contributor

izhuravlev commented Feb 23, 2021

cc @birtony @izhuravlev

@izhuravlev izhuravlev added this to the 1.9 Release milestone Feb 23, 2021
@chrispinkney
Copy link
Contributor

So because MDX is now landed this issue could be a lot of fun for whoever wants to work on it.

NextJS can automatically generate routes for files found in the pages directory (see /search and /about). Because of this (and because of a Pagebase being landed) we can simply pull in the docs in the /docs folder, apply the pagebase, and rinse and repeat (see this pr for info on how this could happen.)

Also, this issue also depends on UI 2.0 as our docs that get rendered will need a touch up or sorts, thus I think this should go in after UI 2.0.

@cindyorangis cindyorangis removed their assignment Feb 24, 2021
@chrispinkney
Copy link
Contributor

@manekenpix Are you still curious about working on this? Anton has expressed interest in this today, maybe you guys would like to collab?

@manekenpix
Copy link
Member

Yes, definitely 👍

@chrispinkney chrispinkney modified the milestones: 1.9 Release, 2.0 Release Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority
Projects
None yet
10 participants