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

Create documentation site (GitHub Pages or Netlify) using Docusaurus #97

Open
halcyondude opened this issue Aug 20, 2022 · 6 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed p1-high project-infra tools, actions, tasks around running the project itself

Comments

@halcyondude
Copy link
Collaborator

halcyondude commented Aug 20, 2022

Two things have bubbled to the top...


GraphQL Voyager


https://github.com/IvanGoncharov/graphql-voyager#graphql-voyager


Docusaurus


image

The docs are amazingly well done.

image


Resources


Aside...proto!

https://protobuffet.com (https://github.com/protobuffet/docusaurus-protobuffet)


IDEA: This could be useful for #54 --> https://github.com/rdilweb/docusaurus-plugin-remote-content

A Docusaurus v2 plugin that downloads content from remote sources.

With this plugin, you can write the Markdown for your content somewhere else, and use them on your Docusaurus site, without copying and pasting.


@halcyondude halcyondude added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed p1-high project-infra tools, actions, tasks around running the project itself labels Aug 20, 2022
@halcyondude
Copy link
Collaborator Author

There's also this...more minimalist. Perhaps this makes sense to include w/ dev setup...

https://github.com/2fd/graphdoc#readme

@AlexxNica
Copy link

I can help with this one, since I'm already doing it for https://github.com/nikas-org/filecoin-plus-docs.

Let's break it down into separate issues though; one for the documentation infra and another one for the graph visualization/plugins. WDYT?

@mohitvdx
Copy link

Hey i am new to the project, can someone help me out and tell how to start contributing?? @halcyondude

@AlexxNica
Copy link

Hey @mohitvdx, we're glad you're interested! We're still working on writing the contributors guide and the docs website, so my suggestion for now would be that you go through issues with the help wanted and good first issue labels. Also, check out more ways of getting involved in the how to contribute section.

@skushagra9
Copy link

Hey , I would love to work on this issue

@AbdoALPOP
Copy link

👋 Hey Matt,

I am interested in your task and available to start immediately.

I am experienced with Docusaurus.io, Nextra, Mkdocs, and markdown. I can provide you with a user-friendly guide.

Here are some of my live guides:

I'm looking forward to hearing from you soon 😃
Contact me and let's get started.

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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed p1-high project-infra tools, actions, tasks around running the project itself
Projects
Status: Triage
Development

No branches or pull requests

5 participants