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

start a docs web page for the project #8

Open
devmozao opened this issue Jun 26, 2022 · 5 comments
Open

start a docs web page for the project #8

devmozao opened this issue Jun 26, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed to-do task

Comments

@devmozao
Copy link
Collaborator

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 devmozao changed the title TO-DO: start a docs web page for the project start a docs web page for the project Jun 30, 2022
@devmozao devmozao added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 1, 2022
@devmozao
Copy link
Collaborator Author

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

@AlexcastroDev
Copy link

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
Copy link

andrepg commented Jan 21, 2023

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
Copy link
Collaborator Author

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
Copy link
Member

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).

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 good first issue Good for newcomers help wanted Extra attention is needed to-do task
Projects
Status: Todo
Development

No branches or pull requests

4 participants