doc: ad2s1210: Update readme file and doc #116
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SaikiranGudla
added
minor_updates
documentation
jansunil
requested changes
Jan 17, 2025
Comment on lines
12
to
+14
| Product details: AD2S1210. | ||
| Product Evaluation board details: EVAL-AD2S1210SDZ | ||
| User Guide for this code: https://wiki.analog.com/resources/tools-software/product-support-software/AD2S1210_mbed_iio_support | ||
| User Guide for this code: https://analogdevicesinc.github.io/precision-converters-firmware/source/projects/ad2s1210_iio/ad2s1210_iio.html |
There was a problem hiding this comment.
do we really need the readme?
There was a problem hiding this comment.
Most of the projects added before GH docs have the readme files. Discussed the same with @gprasadbng, and decided to leave it as is for older projects fixing the broken links.
There was a problem hiding this comment.
In that case, should we update all the wiki links in this readme?
There is another link that points to wiki in line-54 "Find detailed instructions here...."
Update userguide link in readme file. Update table alignment in GH doc rst file. Signed-off-by: SGudla <Saikiran.Gudla@analog.com>
SaikiranGudla
force-pushed
the
update-readme-files
branch
from
2ba7070 to
bb22737
Compare
jansunil
approved these changes
Jan 17, 2025
D-Disha
approved these changes
Jan 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update userguide link in readme file.
Update table alignment in GH doc rst file.