Skip to content

docs: Update retina shell documentation#1854

Merged
ibezrukavyi merged 2 commits into
microsoft:mainfrom
kamilprz:kamilp/retina-shell-docs
Sep 22, 2025
Merged

docs: Update retina shell documentation#1854
ibezrukavyi merged 2 commits into
microsoft:mainfrom
kamilprz:kamilp/retina-shell-docs

Conversation

@kamilprz

@kamilprz kamilprz commented Aug 29, 2025

Copy link
Copy Markdown
Contributor

Description

Updating the retina shell documentation to be more comprehensive.

Removing the readme from /shell in favour of the documentation page to avoid having to maintain two documents.

Related Issue

#1835

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

Signed-off-by: Kamil <kamil.prz@gmail.com>
@kamilprz kamilprz requested a review from a team as a code owner August 29, 2025 16:34
@kamilprz kamilprz requested review from apontejaj and mugeshsp August 29, 2025 16:34

@alexcastilio alexcastilio left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left some comments

Comment thread docs/06-Troubleshooting/shell.md Outdated
Comment thread docs/06-Troubleshooting/shell.md Outdated
Comment thread docs/06-Troubleshooting/shell.md Outdated
Signed-off-by: Kamil <kamil.prz@gmail.com>

@alexcastilio alexcastilio left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ibezrukavyi ibezrukavyi added this pull request to the merge queue Sep 22, 2025
Merged via the queue into microsoft:main with commit 1a39123 Sep 22, 2025
31 checks passed
agrawaliti pushed a commit to agrawaliti/retina that referenced this pull request Oct 22, 2025
# Description

Updating the retina shell documentation to be more comprehensive.

Removing the readme from `/shell` in favour of the documentation page to
avoid having to maintain two documents.

## Related Issue

microsoft#1835

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/Contributing/overview).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

---------

Signed-off-by: Kamil <kamil.prz@gmail.com>
mereta pushed a commit that referenced this pull request Dec 2, 2025
# Description

Updating the retina shell documentation to be more comprehensive.

Removing the readme from `/shell` in favour of the documentation page to
avoid having to maintain two documents.

## Related Issue

#1835

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/Contributing/overview).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

---------

Signed-off-by: Kamil <kamil.prz@gmail.com>
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.

3 participants