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

Document console settings #787

Open
jovatn opened this issue Oct 30, 2024 · 1 comment
Open

Document console settings #787

jovatn opened this issue Oct 30, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jovatn
Copy link
Contributor

jovatn commented Oct 30, 2024

For products with console ports, it would be good with documentation on port settings (115200 8N1).
Or is this too product specific and not suitable for general documentation?

Also, showing how to disable the console port in CLI would be suitable together with such documentation.

@jovatn jovatn converted this from a draft issue Oct 30, 2024
@jovatn jovatn added documentation Improvements or additions to documentation triage Pending investigation & classification (CCB) labels Oct 30, 2024
@troglobit troglobit removed the triage Pending investigation & classification (CCB) label Oct 31, 2024
@troglobit troglobit added this to the Infix v24.11 milestone Oct 31, 2024
@troglobit troglobit modified the milestones: Infix v24.11, Infix v24.12 Nov 12, 2024
@troglobit
Copy link
Contributor

At the latest CCB we decided this was a bit too specific for the general docs. Product specific info fits better in a datasheet in the product's repo.

The information though is very relevant to document somewhere, and for now it fits best in our board-specific READMEs, e.g.

The console port of latter, for example, runs at 1500000 8N1.

Suggestion: we should of course keep the board-specific section updated, but maybe we can fit a "connecting to your device" section into the general docs. It must of course point to "your product's data sheet" for the specific settings, but the general information, like how to disable the console port and recommending using resize from the shell, could find a home in the docs.

@jovatn jovatn self-assigned this Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants