pgh-public-meetings / city-scrapers-pitt

Pittsburgh City Scrapers: sourcing public meetings in Pittsburgh
https://pgh-public-meetings.github.io/events/
MIT License
19 stars 66 forks source link

Improving Documentation #212

Open maxachis opened 3 years ago

maxachis commented 3 years ago

This is a broad issue for identifying parts of our documentation that we believe should be improved.

Right now, for example, the Readme.md file is very sparse, and people new to coding or web scraping might be intimidated by the relative scarcity of information. One solution is to add additional details to the Readme file, or to create a link to a FAQ section (along with a FAQ file).

maxachis commented 3 years ago

Additional notes:

Clean up Navigation -- we have several different landing points, like for if you've never

Can move the calendar link to the bottom, and provide more description of where you should go among different pages.

Include links to more documentation files in either readme or FAQ. In particular, link to "Integration Testing".