Create initial Dev Docs - #187
justinschwerdtfeger wants to merge 44 commits into
Conversation
|
@Yogeb-tech Can you finish this up? |
|
Yes, ideally I will have it done by the end of this week |
|
Windows build is failing #188. We definetly want to get a fix in |
|
just a random thought, the AI I was using to make initial drafts wrote a lot of numbers in the headers. I don't really like this, and I was working to remove most of them |
I found orchrestration could be replaced with simpler language
Update documentation, especially project architecture and structure pages
|
|
||
| | Command | Description | | ||
| | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `./api-tools --scrape --coursebook --term 24F` | Scrapes CourseBook data for Fall 2024.<br>• `--resume`: Resume from last completed course prefix.<br>• `--startprefix <prefix>`: Begin at a specific course prefix (e.g. `cp_cs`). | |
There was a problem hiding this comment.
This example command won't work because the term is invalid. Must be a lowercase f, not uppercase F.
There was a problem hiding this comment.
good catch
| | Command | Description | | ||
| | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `./api-tools --scrape --coursebook --term 24F` | Scrapes CourseBook data for Fall 2024.<br>• `--resume`: Resume from last completed course prefix.<br>• `--startprefix <prefix>`: Begin at a specific course prefix (e.g. `cp_cs`). | | ||
| | `./api-tools --scrape --evals --term 24F` | Scrapes CourseBook course evaluation data for the specified term. | |
There was a problem hiding this comment.
Don't know what format term currently uses for the evaluation data, but we should try to keep it the same as with coursebook.
There was a problem hiding this comment.
I meant that we shouldn't have:
./api-tools --scrape --coursebook --term 24f
./api-tools --scrape --evals --term 24F
Where one uses a lowercase f, s, or u, and the other uses uppercase. Both should follow the same format.
AbhiramTadepalli
left a comment
AbhiramTadepalli
left a comment
There was a problem hiding this comment.
i like the structure
This branch has not been deployed
4 participants
Description
Adds developer documentation to Github Wiki using
Andrew-Chen-Wang/github-wiki-action@v5GitHub action.Testing
AI Disclosure
I used AI to write initial docs based on my layout, then heavily edited them.
Checklist
Home.md,Getting-Started.md, andHow-to-Contribute.mdDocker-Guide.md,Project-Structure.md, andTroubleshooting.mdREADME.md