eruptionjs/core

start a docs web page for the project

devmozao opened this issue · 5 comments

devmozao commented

The goal with the docs is to show with great detail, how the boilerplate works. Experienced users generally does not need, but less experienced devs might get confused, specially the way to commit, test and build with.

devmozao commented

As I recently discovered, Docusaurus may be a starting point to have a complete documentation to the project: https://docusaurus.io

alexcastrodev commented

Hello!

I start my documentation with: Docsify:
https://alexcastrodev.github.io/castroclock-documentation/#/

And my newest project is using Notion XD
https://github.com/AlexcastroDev/flexysearch

Anyways, this is my 1 coin.
if i could help y'll, count with me. :)

andrepg commented

Hey @devmozao, how it's going this issue? I don't have that much knowledge in React/Typescript, but can give my 2 cents with Vue, Static pages and some integration. What we can discuss and from where can we start from?

devmozao commented

Hey @devmozao, how it's going this issue? I don't have that much knowledge in React/Typescript, but can give my 2 cents with Vue, Static pages and some integration. What we can discuss and from where can we start from?

@andrepg damn, sorry on the long waited reply. I didn't get a notification about this comment.

@raisiqueira started a docs made on top of astro starlight's boilerplate, so that was something that we thought that would be good at.

@raisiqueira can we push that repo to eruption and make a draft v0.0.1 to help visualizing and help in contributions?

raisiqueira commented

Hey @devmozao, how it's going this issue? I don't have that much knowledge in React/Typescript, but can give my 2 cents with Vue, Static pages and some integration. What we can discuss and from where can we start from?

@andrepg damn, sorry on the long waited reply. I didn't get a notification about this comment.

@raisiqueira started a docs made on top of astro starlight's boilerplate, so that was something that we thought that would be good at.

@raisiqueira can we push that repo to eruption and make a draft v0.0.1 to help visualizing and help in contributions?

Here is the repository of the site: https://github.com/eruptionjs/website.

Things to do:

  • Define the color palette.
  • Create the initial .MD files.
  • Replace the emoji with an SVG file (high resolution).
  • 🚀2