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

CORE: Documentation #61

Open
limh0228 opened this issue Jul 23, 2019 · 0 comments
Open

CORE: Documentation #61

limh0228 opened this issue Jul 23, 2019 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed important Prioritze this issue over others

Comments

@limh0228
Copy link
Contributor

limh0228 commented Jul 23, 2019

The site should have more documentation for new developers. Maybe we can add this to the wiki, or link it from the README?

  • Adding more documentation to each source code file
  • Adding structural documentation to explain how the files interact with each other, and the communication hierarchies
  • Adding documentation to explain how the site uses Leaflet
  • Maybe a brief intro to MVC model?
  • Describing which files use what languages, and what they do
@limh0228 limh0228 self-assigned this Jul 23, 2019
@limh0228 limh0228 added the help wanted Extra attention is needed label Jul 23, 2019
@gaskij gaskij added good first issue Good for newcomers important Prioritze this issue over others labels Jan 24, 2020
@Unachieved Unachieved changed the title Documentation CORE: Documentation Feb 19, 2020
@Unachieved Unachieved self-assigned this Feb 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed important Prioritze this issue over others
Projects
None yet
Development

No branches or pull requests

3 participants