Skip to content

Commit

Permalink
docs: git callouts (#1064)
Browse files Browse the repository at this point in the history
copy edits for the upcoming launch 🤐
  • Loading branch information
kanadgupta authored Nov 13, 2024
1 parent 93a989b commit f9c7d09
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ With `rdme`, you can manage your API definition (we support [OpenAPI](https://sp

Not using ReadMe for your docs? No worries. `rdme` has a variety of tools to help you identify issues with your API definition — no ReadMe account required.

> [!WARNING]
> Heads up: our [new ReadMe Refactored experience](https://docs.readme.com/main/docs/welcome-to-readme-refactored) doesn’t yet support `rdme`. If your project is using the new ReadMe Refactored experience, we recommend [enabling bi-directional syncing with via Git](https://docs.readme.com/main/docs/bi-directional-sync) for an even better editing experience for the technical and non-technical users on your team!
## Table of Contents

<!--
Expand Down
4 changes: 4 additions & 0 deletions documentation/rdme.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ With `rdme`, you can create workflows for a variety of use cases, including:
- Pre-upload validation (including OpenAPI 3.1) ✅
- Syncing directories of Markdown files 📖

> 🚧 Heads up!
>
> Our [new ReadMe Refactored experience](https://docs.readme.com/main/docs/welcome-to-readme-refactored) doesn’t yet support `rdme`. If your project is using the new ReadMe Refactored experience, we recommend [enabling bi-directional syncing with via Git](https://docs.readme.com/main/docs/bi-directional-sync) for an even better editing experience for the technical and non-technical users on your team!
## General Setup and Usage

To see detailed CLI setup instructions and all available commands, check out [the `rdme` GitHub repository](https://github.com/readmeio/rdme#readme).
Expand Down

0 comments on commit f9c7d09

Please sign in to comment.