Documentation for Admin

[guidiego]

Description

As a new product, we need to create minimal documentation to made pRest.admin easy to be set on any user environment.

[worais]

If you need I can help.

[avelino]

If you need I can help.

Very good @geekdoagrest, @guidiego updates the issue how you think about documenting and what he recommends to use to write the documentation.

I recommend staying inside the official documentation of the project, so we would use Hugo, more here

[worais]

@avelino I already worked with Hugo in tabless website. it's very quiet...

[guidiego]

Yeah! I agree, add the doc inside project will be the better approach!

About Technologie, I'd like to use Docusaurs, it's a Facebook documentation lib that use react to customize templates and this kind of things. Like Hugo, we use .md to populate our documentation. But I am open to discuss about it!

[worais]

@guidiego I looked at the docusaurus documentation and it seems easy, if it is not a problem to use something other than the official documentation, I agree.

[guidiego]

@geekdoagrest I've used Hugo before and doesn't see any problems in use it! My point with Docusaurus is:

• We could add it on package.json and not install more deeps to run
• More friendly to edit templates (talking about React developers)
• I really like Docusaurus flexibility

Also, I 100% confident that if you prefer use Hugo you will make a good job! So feel free to take this decision and I will be glad to review your PR! 🥳

[worais]

@guidiego ok, I also think the Docusaurus is the best way. Commit this repo or https://github.com/prest/prest.admin?

[guidiego]

@geekdoagrest in prest.admin please! Here we will only tracking issues :)

[c-nv-s]

I'm trying to build the documentation locally for offline use. What are the commands to build it please?