Add developer documentation#36
Merged
Merged
Conversation
adamltyson
approved these changes
Jun 1, 2026
adamltyson
left a comment
adamltyson
left a comment
Member
There was a problem hiding this comment.
LGTM, just a couple of tiny suggestions
| "name": "GitHub", | ||
| # URL where the link will redirect | ||
| "url": "provide later", # required | ||
| "url": "https://github.com/neuroinformatics-unit/OSCaR", |
Collaborator
Author
There was a problem hiding this comment.
I'll use this domain when I setup the github pages deployment 👍
This line refers to the link for the github logo at the top right of the website - so I'll leave that one as-is.
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
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.
Description
What is this PR
Why is this PR needed?
Currently, there are no docs for developer setup
What does this PR do?
pyproject.toml, so they're all in one placeI'll add a link to the built github pages site, once I've set that up in the project settings.
References
Closes #35
How has this PR been tested?
N/A - only docs changes
Is this a breaking change?
No
Does this PR require an update to the documentation?
Docs have been updated.
Checklist: