I had some documentation that I wanted to propose updates against but don’t see it on github under the FreeRTOS organization and searching for keywords on the page doesn’t turn anything up.
Hello @cmorganBE,
The website is not in github. We make changes to it through wordpress for now - it is not accessible externally.
For the time being, can you propose the changes in this thread so that we can take a look and add them to the next update of the website?
Thanks,
Aniruddha
Ahh k. I can look at making those updates and posting here. Would be nice to get the website in version control ![]()
Hello @cmorganBE,
Thank you for your contribution.
We are currently working to move our website contents under version control. The plan is to make it public in Q3, 2024 so that we can collaborate better with the FreeRTOS community.
Thank you,
Keishi
Hi all,
I am following up on this thread to see if there are any updates regarding hosting the website content in a public version control system.
Since the initial plan was targetted for Q3 2024, I was wondering if this transition has already taken place, or if the website source/documentation is now available on GitHub for community contributions?
If not, is there an updated timeline or a specific repository we should keep an eye on?
Thanks!
This looks to have fallen down the cracks and we didnt track this work. I will bring this topic up within the team and come back here on this thread
Hi @codersjj,
Thanks for following up, and apologies for the long silence on this thread.
While we discuss on the next steps, here is the update for now: the freertos.org website content is not yet available in a public repository, so there isn’t a public repo you can open pull requests against for the website pages today. The earlier plan to move the site under public version control didn’t get completed, and we don’t have a committed public repo or timeline to share right now.
In the meantime, here’s how you can get changes in:
-
Documentation that lives in source code — API reference, READMEs, code comments, and examples in the libraries — is already on GitHub and open to contributions. You can open a PR directly against the relevant repo under https://github.com/FreeRTOS (for example, FreeRTOS-Kernel or the individual
coreMQTT/coreHTTP/ etc. repos). Please review theCONTRIBUTINGguidelines in each repo first. -
Website page content (prose, typos, clarifications on freertos.org pages) — since these aren’t in a public repo yet, the best path is to reply here with the page URL and your proposed wording. We’ll review it and fold it into the next website update.
If you let us know which specific pages/sections you’d like to improve, we’re happy to take a look. We’ll also update this thread if the public-versioning situation changes.
Thanks for wanting to contribute — it’s much appreciated.