Create a documentation page - Githubissues

blumilksoftware / interns-2022c-internships

Intership programme application made by interns themselves.

MIT License

5 stars 5 forks source link

Create a documentation page #192

Closed plencka closed 1 year ago

plencka commented 1 year ago

The project aims to allow colleges to create a list of companies looking for interns.

For that we should create a documentation to explain features and structure of the application.

It should probably have two parts, like:

Technical:
- General description of the app and overview of technology used
- Project structure
- Setup and installation
- How to run seeders and test application manually (check webpage, see database for example in DataGrip, tinker)
- How to run automatic tests (when they get implemented)
- How to create an admin account
- Intended behaviour and implementations / other stuff I did not think of right now
End user:
- Nice overview of what this application is with fancy screenshots
- How to use the company browser
- How to create a company, explanation of the verification process
- Admin panel and all related stuff
- And more?

I think the documentation page could be hosted in Github Pages as a static website, maybe using a VuePress template?