M48 documentation: replace placeholder pages with real content - #7
Merged
Merged
Conversation
Add the software catalogue, getting started with the CoreSense Pixi channels, architecture design, tutorials (cs4home modules, RiskAM, publishing with Pixi), the manufacturing and social testbeds, real demos and about pages, and the EU funding acknowledgement. Add a redirect from /Toolchain/ to /toolchain/, which is the URL cited in deliverable D4.4. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Resolve the documented RiskAM, Pixi, and /Toolchain/ redirect issues before approval.
Review effort: Lite
Findings: 2
Open (3)
What changed in this PR
Replaces placeholder pages with complete CoreSense documentation for installation, architecture, tutorials, testbeds, demos, and project information.
Changes:
- Adds Pixi, apt, source-build, RiskAM, cognitive-module, and release guides.
- Documents software repositories, architecture, testbeds, demos, and contributions.
- Adds funding acknowledgements and a legacy
/Toolchain/redirect.
| File | Reviewed changes |
|---|---|
tutorials/index.rst |
Replaces placeholder tutorial navigation. |
tutorials/docs/riskam.rst |
Adds RiskAM guidance; correct the depth encoding and run_bagger argument. |
tutorials/docs/pixi_release.rst |
Adds Pixi publishing guidance; make the API key placeholder shell-safe. |
tutorials/docs/dummy.rst |
Removes placeholder tutorial content. |
tutorials/docs/cs4home_modules.rst |
Adds cognitive-module tutorial. |
testbeds/index.rst |
Adds testbed navigation. |
testbeds/docs/social_testbed.rst |
Documents the social testbed. |
testbeds/docs/manufacturing_testbed.rst |
Documents the manufacturing testbed. |
README.md |
Adds funding acknowledgement. |
packages/index.rst |
Adds the software catalogue. |
opensourecommunity/index.rst |
Adds release guidance. |
instrumentation/index.rst |
Corrects instrumentation documentation. |
index.rst |
Updates the project overview and navigation. |
getting_started/index.rst |
Adds Pixi quickstart guidance. |
extra/Toolchain/index.html |
Adds the legacy URL redirect. |
design/index.rst |
Documents architecture; fix punctuation around “understanding”. |
demos/index.rst |
Replaces the demo placeholder listing. |
demos/docs/dummydemo.rst |
Removes placeholder demo content. |
conf.py |
Configures documentation and redirect assets; fix exclusion and output-path handling for /Toolchain/. |
build_instructions/index.rst |
Documents Pixi, apt, and source builds. |
about/index.rst |
Adds project, consortium, and funding information. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Requirements | ||
| ============ | ||
|
|
||
| - An RGB camera and an absolute depth image in metres. The defaults are calibrated for Intel RealSense D4xx cameras. |
|
|
||
| .. code-block:: bash | ||
|
|
||
| ros2 launch riskam_bringup riskam.launch.py run_logger:=true |
| ################ | ||
|
|
||
| CoreSense general design. | ||
| CoreSense is a hybrid cognitive architecture that gives robots the capability of *understanding*, the world and themselves, and of *awareness*, understanding in synchrony with perception. The theory behind it is described in the public deliverables `D1.3 Theory of Understanding <https://www.coresense.eu/doc/CS-050.pdf>`_ and `D1.4 Theory of Awareness <https://www.coresense.eu/doc/CS-060.pdf>`_. The terms used in the software follow the `CoreSense Ontology (CSO) <https://w3id.org/coresense/cso>`_. |
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
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.


Replaces the placeholder pages (TBD, dummy tutorial and demo) with the documentation of the CoreSense software for the end of the project (D5.4).
coresense-jazzy,coresense-kilted), tested with EasyNav.cs4home_architecture) and the understanding system.cs4home_examples, RiskAM, and publishing a package in the Pixi channels (same guide as D5.1, section 2.10)./Toolchain/to/toolchain/: deliverable D4.4 cites the capitalised URL, which currently returns 404.Built locally with Sphinx 9.1 without errors;
linkcheckreports no broken links.🤖 Generated with Claude Code