Skip to content

M48 documentation: replace placeholder pages with real content - #7

Merged
fmrico merged 2 commits into
mainfrom
m48-content
Sep 27, 2026
Merged

fmrico merged 2 commits into
mainfrom
m48-content

Conversation

@fmrico

@fmrico fmrico commented Sep 26, 2026

Copy link
Copy Markdown
Member

Replaces the placeholder pages (TBD, dummy tutorial and demo) with the documentation of the CoreSense software for the end of the project (D5.4).

  • Getting started with the CoreSense Pixi channels (coresense-jazzy, coresense-kilted), tested with EasyNav.
  • Build and install: Pixi, apt and source.
  • Design: architecture subsystems, cognitive modules (cs4home_architecture) and the understanding system.
  • Software catalogue: main repositories grouped by topic, with how to install each one.
  • Tutorials: cognitive modules with cs4home_examples, RiskAM, and publishing a package in the Pixi channels (same guide as D5.1, section 2.10).
  • Testbeds: manufacturing and social testbeds added next to the inspection one.
  • Demos, About, Contribution guideline with real content and the EU funding acknowledgement.
  • Redirect from /Toolchain/ to /toolchain/: deliverable D4.4 cites the capitalised URL, which currently returns 404.

Built locally with Sphinx 9.1 without errors; linkcheck reports no broken links.

🤖 Generated with Claude Code

fmrico and others added 2 commits September 26, 2026 21:06
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>
Copilot AI lite review requested due to automatic review settings September 26, 2026 20:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Resolve the documented RiskAM, Pixi, and /Toolchain/ redirect issues before approval.

Review effort: Lite
Findings: 2 Medium severity · 1 Low severity

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.

Comment thread tutorials/docs/riskam.rst
Requirements
============

- An RGB camera and an absolute depth image in metres. The defaults are calibrated for Intel RealSense D4xx cameras.
Comment thread tutorials/docs/riskam.rst

.. code-block:: bash

ros2 launch riskam_bringup riskam.launch.py run_logger:=true
Comment thread design/index.rst
################

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>`_.
@fmrico
fmrico merged commit cc99304 into main Sep 27, 2026
1 check passed
@fmrico
fmrico deleted the m48-content branch September 27, 2026 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants