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.

Sign up for GitHub

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

Jump to bottom

Documentation for repo #62

Closed
14 tasks
Hussein-Mahfouz opened this issue Oct 31, 2024 · 0 comments · Fixed by #63
Closed
14 tasks

Documentation for repo #62

Hussein-Mahfouz opened this issue Oct 31, 2024 · 0 comments · Fixed by #63
Assignees
@Hussein-Mahfouz
Labels
documentation Improvements or additions to documentation

Comments

@Hussein-Mahfouz
Copy link
Collaborator

Hussein-Mahfouz commented Oct 31, 2024 •
edited
Loading

[1] Main README.md

Sections:

  • Motivation
  • Contribution
  • Installation
  • How to Run the Pipeline
    • Data Inputs
    • Config
    • Running
  • Future Work
  • Related Work

Other:

  • Fix Ci, python, pipy banners (@sgreenbury could you help with this?)
  • Add contents at the top with links to README sections

[2] Scripts/README.md

  • explanation of each script

[3] Data/external/README.md

  • How to find / generate each initial dataset
  • highight optional datasets
@Hussein-Mahfouz Hussein-Mahfouz added the documentation Improvements or additions to documentation label Oct 31, 2024
@Hussein-Mahfouz Hussein-Mahfouz self-assigned this Oct 31, 2024
@Hussein-Mahfouz Hussein-Mahfouz mentioned this issue Oct 31, 2024
Merged
@Hussein-Mahfouz Hussein-Mahfouz linked a pull request Oct 31, 2024 that will close this issue
initial documentation #63
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Hussein-Mahfouz Hussein-Mahfouz

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

initial documentation Urban-Analytics-Technology-Platform/acbm
1 participant
@Hussein-Mahfouz