Skip to content

Documentation part 1#118

Merged
kr-t merged 12 commits intomainfrom
rewrite-docs
Jan 19, 2026
Merged

Documentation part 1#118
kr-t merged 12 commits intomainfrom
rewrite-docs

Conversation

@casaroli
Copy link
Contributor

@casaroli casaroli commented Jan 9, 2026

Description

This is the first of a series of PRs adding documentation for the new ocre rewrite from #116.

Other pages will come in the next PRs and then a final PR integrating the documentation generation.

As usual, if you have any questions, feel free to reach out!

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Just read the .md files in GitHub.

Checklist:

  • I have made corresponding changes to the documentation

@casaroli casaroli force-pushed the rewrite-docs branch 3 times, most recently from 02b0d4b to a229d78 Compare January 13, 2026 12:04
@casaroli casaroli changed the title Documentation for the rewrite Documentation about Tests Jan 13, 2026
@casaroli casaroli changed the title Documentation about Tests Documentation about Tests and Getting Started Jan 13, 2026
@casaroli casaroli marked this pull request as ready for review January 13, 2026 12:07
@casaroli casaroli changed the title Documentation about Tests and Getting Started Documentation about tests and Getting Started guide Jan 13, 2026
@casaroli casaroli changed the title Documentation about tests and Getting Started guide Documentation part 1 Jan 13, 2026
Copy link
Collaborator

@kr-t kr-t left a comment

Choose a reason for hiding this comment

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

Do we want to maybe replace the sample app in the future from the board to a simulation? Like everyone can run native_sim or its 64b version
note: we refer to physical board in sample commands in samples folder, but to native_sim in GetStartedZephyr guide,

Otherwise, guides look good to me, once we fix minor typos.

west flash
```

which should not erase the storage partition.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not always true. From my experience, whether zephyr flash is called w --erase or --no-erase depends on the target and differs from board to board. For example, on U585, west flash would erase the storage partition if it is located in the main flash (same as app), but not touch it if it is located on external flash. More often than not, using --no-erase might make sense to be included on subsequential flashes. Then, once again, some targets just ignore it completely.

Copy link
Collaborator

Choose a reason for hiding this comment

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

P.S. This is just a note regarding Zephyr, I don't think we must do anything w it, just might want to note for the future if we'll have inconsistencies.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then I guess it will depend on the runner. In the pico, if I don't pass --erase it will just erase the area of the flash being written IIRC. Maybe we should add a note about --no-erase

@kr-t
Copy link
Collaborator

kr-t commented Jan 15, 2026

closes #122

We add the Devcontainer and Getting Started guides for Zephyr and
Linux.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
We add the documentation about system tests, memory leak checks
and source code test coverage reporting.

Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
@kr-t kr-t merged commit 09a87eb into main Jan 19, 2026
16 checks passed
@kr-t kr-t deleted the rewrite-docs branch February 3, 2026 10:35
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