Readme content - Githubissues

rsmp-nordic / rsmp_core

RSMP core specification

MIT License

6 stars 1 forks source link

Readme content #173

Open emiltin opened 1 week ago

emiltin commented 1 week ago

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 commented 1 week ago

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.