Introducing ReadMe's Doc API

ReadMe has expanded its API capabilities, now allowing users to sync markdown files from their computers to ReadMe projects, a feature highly requested by engineers. This update is facilitated through the newly updated rdme command line tool, version 2, which enables seamless integration into workflows, supporting tasks like documentation updates via pull requests, resolving merge conflicts locally, and automated updates during deployments using CI/CD. While this development offers greater flexibility in managing documentation, it also introduces potential challenges due to the exposure of previously internal property names, which may lead to undocumented properties or complex actions. Users can choose to sync documentation selectively and must manage deletions both locally and on ReadMe to ensure accuracy. Future improvements are anticipated, including possible enhancements like syncing entire folders via the API and support for nested folders or includes. Users are encouraged to provide feedback and report any issues to ReadMe's support email.

No tracked trend matches for this post yet.