Skip to content

Conversation

@StaticRocket
Copy link
Member

At this point we should drive users to the container properly. That gives them access to almost all of the CI tools and ensures the output they generate will match what we expect. Advanced users can still parse the requirements.txt if they want.

Also, add an example make command using the container to the top of the build guide since that is one of the more popular things I need to remind people about.

@StaticRocket
Copy link
Member Author

Found a bug in commit-check with this one. commit-check/commit-check#329

@cshilwant
Copy link
Member

Simplify your language. The calculated Flesch–Kincaid grade level of 10.22 is above the recommended reading grade level of 9.

can you address this suggestion from vale

@StaticRocket
Copy link
Member Author

Rats. That's the one thing from Vale I haven't figured out how to satisfy yet.

@jeevantelukula
Copy link
Collaborator

jeevantelukula commented Dec 15, 2025

Rats. That's the one thing from Vale I haven't figured out how to satisfy yet.

We can use Processor SDK Documentation instead.
Using shorter sentences, simpler words, acronyms would greatly help. See: https://clickhelp.com/clickhelp-technical-writing-blog/improve-the-readability-of-your-technical-documentation-with-flesch/

@StaticRocket
Copy link
Member Author

Processor SDK Documentation includes an undefined acronym though. Bit of a circular issue.

@StaticRocket
Copy link
Member Author

Funnily enough, dramatically reducing text actually makes this worse as we have fixed words with large syllable counts that are hard to work around.

https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests#Flesch%E2%80%93Kincaid_grade_level

At this point we should drive users to the container properly. That
gives them access to almost all of the CI tools and ensures the output
they generate will match what we expect. Advanced users can still parse
the requirements.txt if they want.

Also, add an example make command using the container to the top of the
build guide since that is one of the more popular things I need to
remind people about.

Signed-off-by: Randolph Sapp <rs@ti.com>
@cshilwant cshilwant merged commit 659ef02 into TexasInstruments:master Dec 17, 2025
2 of 3 checks passed
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.

4 participants