The snap-in imports articles from your ReadMe account into DevRev, creating and updating knowledge base articles from either guides or API reference docs. A single command syncs content so you don’t have to copy your knowledge base manually.

Features

• Automated Article Import

Fetches articles from ReadMe (guides or reference section) and creates corresponding articles in DevRev.

• Knowledge Base Sync

Re-run import to update existing articles and add new ones, content and mapping are kept in sync.

• Guides and Reference

Supports ReadMe API v1 and v2, v2 you can choose to import from Guides or Reference (API docs).

Installation

1. Go to the Snap-ins section in your DevRev workspace settings.
2. Click on All Snap-ins
3. Search ReadMe, and Click on Install next to the ReadMe snap-in.
4. In Configs, add a connection, set the Part and Owner for the imported articles. Optionally set ReadMe API Version (v1 or v2), ReadMe Branch/Version and Category Section.
5. Deploy the snap-in.

Usage

1. Open the snap-in Discussions and run the /initiateArticleImport command to start the import or sync the updates.
2. The snap-in fetches articles from ReadMe (guides or reference, per config) and creates or updates articles in DevRev.
3. When the run finishes, the snap-in posts a message in Discussions with the import status.