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.

Sign up for GitHub

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

Jump to bottom

Readme content #173

Open

emiltin opened this issue Sep 9, 2024 · 1 comment

Labels

refine

Milestone

Contributor

emiltin commented Sep 9, 2024 •

edited

Loading

The Readme includes a prominent section on generating documentation from source https://github.com/rsmp-nordic/rsmp_core?tab=readme-ov-file#generating-the-specification-from-source

I wonder if this is needed in the readme, as the documention is available online, and also as PDF download.

Perhaps it would be better to have things like:

link to RSMP Nordic website
links to Discussions, how to report errors
info about working groups
info about. testing tools
rsmp json schemas

emiltin changed the title ~~Readme section on generating from source needed?~~ Readme content

Contributor Author

emiltin commented Sep 9, 2024

The Readme mentions SXLs, which might be a bit confusing, at least unless there a bit more explanation of the difference between core and SXLs.

emiltin added the refine label

emiltin added this to Core 3.3.0

emiltin added this to the 3.3 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment