Skip to content

Swap README links to live website #3

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

Merged
C-Achard merged 1 commit into from
Nov 3, 2026
Merged

Swap README links to live website #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# SCENE Code & Data Guidelines

**Documentation: [scene-collaboration.github.io/CodeAndDocsTemplate](https://scene-collaboration.github.io/CodeAndDocsTemplate/)**

This repository is the starting point for SCENE code projects: a template repository with packaging, formatting, tests, continuous integration and documentation already set up.

SCENE's shared code lives in the [SCENE-Collaboration](https://github.com/SCENE-Collaboration) GitHub organisation. The template may be used for new repositories here or elsewhere in the consortium.

> **Starting a new project?** Follow [Using this template](docs/guides/using-the-template.md), step by step.
> **Starting a new project?** Follow [Using this template](https://scene-collaboration.github.io/CodeAndDocsTemplate/using-the-template/), step by step.

- [Project standards](docs/guides/guidelines.md): project layout, formatting and linting, CI, lockfiles, containers and DataJoint.
- [Collaborating on code](docs/guides/development-guide.md): Git workflow, code style, issues, pull requests and code review.
- [Documentation with Jupyter Book](docs/guides/jupyter-book.md), built from [`docs/`](docs/) and published to GitHub Pages.
- [Contributed examples](docs/contributed-examples/contributed-examples.md) from SCENE labs.
- [Project standards](https://scene-collaboration.github.io/CodeAndDocsTemplate/guidelines/): project layout, formatting and linting, CI, lockfiles, containers and DataJoint.
- [Collaborating on code](https://scene-collaboration.github.io/CodeAndDocsTemplate/development-guide/): Git workflow, code style, issues, pull requests and code review.
- [Documentation with Jupyter Book](https://scene-collaboration.github.io/CodeAndDocsTemplate/jupyter-book/), built from [`docs/`](docs/) and published to GitHub Pages.
- [Contributed examples](https://scene-collaboration.github.io/CodeAndDocsTemplate/contributed-examples/) from SCENE labs.

Suggestions and contributions are welcome: please open an issue or a pull request!

Expand Down
Loading