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

Better documentation #176

Open
icxes opened this issue Jan 22, 2025 · 0 comments
Open

Better documentation #176

icxes opened this issue Jan 22, 2025 · 0 comments
Assignees
Labels
documentation issue is related to documentation high-priority issue should should be resolved as soon as possible pre-1.0 issue needs to be resolved before launch

Comments

@icxes
Copy link
Collaborator

icxes commented Jan 22, 2025

Project could use better documentation all around

valkyrie:

  • developer docs for different modules, functions and whatnot (note: this doesn't mean comments in the code)
  • explain why and what the different parts of hanyuu.exe do
  • actually document configuration

valkyrie-themes:

  • how to set up
  • how to develop themes
  • bulma 101 and how we do/don't use it
  • maybe some kind of style guidelines (should probably clean up the current templates/(s)css to actually follow one first)

valkyrie-dev-env:

  • actually make this public
  • whatever is necessary here, maybe try to make script babby proof first, then figure out how something could go wrong anyway and write about that
@icxes icxes added high-priority issue should should be resolved as soon as possible pre-1.0 issue needs to be resolved before launch labels Jan 22, 2025
@icxes icxes added the documentation issue is related to documentation label Jan 22, 2025
@icxes icxes mentioned this issue Jan 22, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issue is related to documentation high-priority issue should should be resolved as soon as possible pre-1.0 issue needs to be resolved before launch
Projects
None yet
Development

No branches or pull requests

2 participants