Skip to content
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.

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

docs: Move sensor.rst to sensor/index.rst #73740

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

teburd
Copy link
Collaborator

@teburd teburd commented Jun 4, 2024

Looking to expand the sensor docs and break out significant sections. First though to move this to a directory to allow for multiple sensor related rst docs.

ubieda
ubieda previously approved these changes Jun 4, 2024
nashif
nashif previously approved these changes Jun 4, 2024
@nashif nashif added the Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc. label Jun 4, 2024
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

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

As you're renaming an existing page, can you please add a redirect in doc/_scripts/redirects.py?
This way people navigating e.g. https://docs.zephyrproject.org/2.7.6/reference/peripherals/sensor.html don't get a 404 when clicking to "see the latest version of this page". Thanks!

@teburd teburd dismissed stale reviews from nashif and ubieda via d8fb868 June 4, 2024 21:42
@teburd teburd requested a review from carlescufi as a code owner June 4, 2024 21:42
Looking to expand the sensor docs and break out significant sections.
First though to move this to a directory to allow for multiple sensor
related rst docs.

Signed-off-by: Tom Burdick <[email protected]>
@teburd
Copy link
Collaborator Author

teburd commented Jun 4, 2024

As you're renaming an existing page, can you please add a redirect in doc/_scripts/redirects.py? This way people navigating e.g. https://docs.zephyrproject.org/2.7.6/reference/peripherals/sensor.html don't get a 404 when clicking to "see the latest version of this page". Thanks!

done, but I'm not sure if I did it right

@kartben
Copy link
Collaborator

kartben commented Jun 5, 2024

done, but I'm not sure if I did it right

you did :) thanks!
https://builds.zephyrproject.io/zephyr/pr/73740/docs/hardware/peripherals/sensor.html

@dleach02 dleach02 merged commit 753f8ff into zephyrproject-rtos:main Jun 5, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Infrastructure area: Documentation area: Process area: Sensors Sensors Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants