[Issue 402] Updates README.md and Supporting docs #433
Conversation
|
Noting this doesn't incorporate base docker-compose.yml and Makefile. |
acouch
requested review from
SammySteiner,
daphnegold,
widal001 and
decause-gov
documentation/notice_of_funding_opportunity_prototypes/README.md
Outdated
Show resolved
Hide resolved
acouch
force-pushed
the
acouch/issue-402-update-readme-usdr
branch
from
dae1dd8
to
e5705d8
Compare
| @@ -0,0 +1,3 @@ | |||
| # Front-end Documentation | |||
|
|
|||
| Documentation for the Next.JS-based front-end can be found in this directory and the [frontend README.md](../../frontend/README.md). | |||
There was a problem hiding this comment.
…can be found in this directory…
The only thing in this directory really is the i18n docs. The instructions for running the frontend app live in the other frontend README. At first, I was gonna suggest we didn't need a /documentation/frontend/README and a /frontend/README (internationalization.md could just be moved to the app directory). However, the api has a lot more in the documentation/ folder. We should be consistent, but I wonder if it might confuse new folx that some docs are w/ their specific apps in the monorepo and some are in the documentation folder?
I'm not suggesting a change here. Just noting potential confusion.
There was a problem hiding this comment.
We got confirmation that this directory and its content (the prototypes) can be nixed (they're in Sharepoint now). Slack thread.
| Now, any time you commit code to the repository, the hooks will run on all modified files automatically. If you wish, you can force a re-run on all files with `pre-commit run --all-files`. | ||
|
|
||
| ### Testing | ||
| Documentation and development instructions for the front-end are provided in the [Front-end README.md](./frontend/README.md). |
There was a problem hiding this comment.
Noticing that the backend and frontend have different doc structure and maybe we should clean that up so it's consistent.
| **Note:** Run everything from within the `/api` folder: | ||
|
|
||
| 1. Install the version of Python specified in [pyproject.toml](../../api/pyproject.toml) | ||
| [pyenv](https://github.com/pyenv/pyenv#installation) is one popular option for installing Python, |
There was a problem hiding this comment.
This link next to the previous link looks confusing. Consider adding a period in between and starting a new sentence.
|
|
||
| 1. Install the version of Python specified in [pyproject.toml](../../api/pyproject.toml) | ||
| [pyenv](https://github.com/pyenv/pyenv#installation) is one popular option for installing Python, | ||
| or [asdf](https://asdf-vm.com/). |
There was a problem hiding this comment.
maybe add more context to asdf, ie. and asdf is another popular tool for managing tool versions for more than just python.
Co-authored-by: Daphne Gold <[email protected]>
Co-authored-by: Daphne Gold <[email protected]>
Co-authored-by: Sumi <[email protected]>
Co-authored-by: Sumi <[email protected]>
Co-authored-by: Daphne Gold <[email protected]>
Co-authored-by: Sammy <[email protected]>
acouch
force-pushed
the
acouch/issue-402-update-readme-usdr
branch
from
438f53f
to
7cf6fcd
Compare
Summary
Fixes #402
Time to review: 10 mins
Changes proposed
Update documentation to incorporate recent activity.