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

[FEATURE REQUEST] Developer documentation #48

Open
btjanaka opened this issue Sep 16, 2019 · 0 comments
Open

[FEATURE REQUEST] Developer documentation #48

btjanaka opened this issue Sep 16, 2019 · 0 comments

Comments

@btjanaka
Copy link
Member

btjanaka commented Sep 16, 2019

Motivation

As most of us graduate this year, we need to pass on materials such as this website. Currently, there is little to no documentation about how to get started with developing the website. If we wish to pass on the website, we will need to provide docs or at least train another webmaster/webmistress.

Proposed Change

Definitely:

  • Getting started with the website, such as building it
  • Updating the various pages of the site

Maybe:

  • A list of links for starting with React (or a link to such a list)
  • A code map of the site (descriptions of what goes where) - though the Create React App template here is fairly standard

Alternatives

Alternatively, it is always possible to say that we do not care about passing on the website, and it is up to future generations to rebuild it from scratch. As this is an educational setting, it may prove a good exercise for budding web devs.

Adoption

We can make sure people can use this properly by asking the next webmaster to take a look at the docs and see if they can figure it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants