chore(docs): Updated the readme docs #256
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
futa-ikeda
previously approved these changes
Aug 15, 2025
Contributor
futa-ikeda
left a comment
futa-ikeda
left a comment
There was a problem hiding this comment.
Just two minor suggestions that are entirely optional. Looks good!
docs/docker.md
Outdated
| @@ -0,0 +1,176 @@ | |||
| # Docker | |||
|
|
|||
| The OSF angular project uses a docker image to simplify that developer process. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| The OSF angular project uses a docker image to simplify that developer process. | |
| The OSF angular project uses a docker image to simplify the developer process. |
docs/git-convention.md
Outdated
| 6. **Open a Pull Request** | ||
| - Go to the main repository on GitHub. | ||
| - Click **New Pull Request**. | ||
| - Select your fork and branch, then create the PR against the `main` branch of the main repo. |
Contributor
There was a problem hiding this comment.
Not sure if we want all PRs to point to main by default. May be better to have them point to develop and make a note that we will release changes from develop to main periodically following our release cycles
bp-cos
force-pushed
the
feature/readme-updates
branch
from
144b582 to
302439d
Compare
futa-ikeda
approved these changes
Aug 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
chore(docs): Updated the readme docs
Summary of Changes
Extracted the README to be multiple docs in the /docs folder
Screenshot(s)
N/A
Side Effects
N/A
QA Notes
N/A