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

refactor: documentation structure #12

Closed
2 tasks done
kinten108101 opened this issue Apr 8, 2023 · 0 comments
Closed
2 tasks done

refactor: documentation structure #12

kinten108101 opened this issue Apr 8, 2023 · 0 comments
Assignees
Milestone

Comments

@kinten108101
Copy link
Owner

kinten108101 commented Apr 8, 2023

/docs should only contain relevant documentations i.e. the workings of SteamVpk.

So far, all three doc files have been about GTK usage, which is personal. In the source code, there are comments about GTK usage. Given this situation, some files have to be refactored.

The documentation locations in question are:

  • /docs
  • Comments

Acceptance criteria

  • All documentation content are moved to the right place

Commentary

I also took the time to improve some docs, specifically Requirement Analysis.md. Now it is Overview.md and contains important information about the projects: the architecture, coding style, etc. This file, however, is only temporary. For example, the coding style section is just a reference to a Youtube video. In the future we will have better means of communicating styles, and it will have a separate file (probably through a contributor/hacking guide).

@kinten108101 kinten108101 added this to the Week 1 milestone Apr 11, 2023
@kinten108101 kinten108101 self-assigned this Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant