prairir / Buoy

A Mesh VPN
MIT License
2 stars 1 forks source link

Hugo docs #6

Open bachittle opened 2 years ago

bachittle commented 2 years ago

Did you read the rules to contributing in CONTRIBUTING.md

I moved contributing.md to the docs. We can decide whether to keep it there or move it back to root

What are you trying to accomplish?

Trying to make a documentation system that can be viewed as a static site (via hugo)

How are you accomplishing it?

in the docs folder is the root to a hugo project. Inside content/ is where all the markdown files are located.

Is there anything reviewers should know?

currently the site is not being hosted, we should discuss what site to host it on (can be as simple as github pages or netlify, since site is static)

If needed, did you change documentation(README.md, ARCHITECTURE.md, etc) to reflect your changes?

I moved documentation, should probably change any references in these documents to each other.

prairir commented 2 years ago

Instead of moving the md files out, can we leave them where they are and use symbolinks to make hugo think they are where it wants it to be

bachittle commented 2 years ago

oh yea that's a good idea, let me do that. Linux for the win :)

bachittle commented 2 years ago

I think it's done now, lmk if I did it right

prairir commented 2 years ago

does it compile correctly with the symbolinks?

bachittle commented 2 years ago

yea it does, I tested it.

prairir commented 2 years ago

LGTM :rocket: