AntiMicroX / AntiMicroX/antimicrox.github.io

Create basic site

Open
#1 23 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
JavaScript
Stars
2
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I think it would be good to discuss, how this site should be done both in terms of technical and in terms of content.

### Technical side:
I think it would be the best solution to make this site using some kind of generator.

In my opinion the best would be combination of [MkDocs](https://www.mkdocs.org/) with [material-theme](https://squidfunk.github.io/mkdocs-material/) it would be deployed using GitHub actions after every push to master branch.

I think MkDocs would be suitable for us because:
- It is easy to write articles here, they can be written using regular Markdown (with additional pieces written in HTML if more flexibility would be needed)
- It has a lot of themes
- can be easily integrated with github pages
(but this seems to be done mainly for documentation, not regular sites, I am not sure)

### Content
I think this side should contain:
- as a main site it would be good to have short, visual description, what antimicrox is, how it looks etc
- some usage instructions (based on old wikis)
- Simple download and install page
- other things from legacy wiki: https://github.com/AntiMicro/antimicro/wiki https://github.com/juliagoda/antimicrox/wiki

I am open for any comments and opinions about solutions proposed above.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.