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

Improving Documentation #212

Open
maxachis opened this issue Jan 9, 2021 · 1 comment
Open

Improving Documentation #212

maxachis opened this issue Jan 9, 2021 · 1 comment

Comments

@maxachis
Copy link
Collaborator

maxachis commented Jan 9, 2021

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
Copy link
Collaborator Author

maxachis commented Jan 9, 2021

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".

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