You can now receive notifications for activity on your ReadMe project in your Slack workspace 🎉 this integration supports the following types of notifications off the bat:

• Suggested Edits: when someone suggests new edits to your project
• Discussions/Support Forums: when someone asks a question in your project's Support Forums

To connect your ReadMe project to your Slack workspace, go to your Project Integrations on ReadMe (Configuration > Integrations), and click the Add to Slack button:

For the latest information on setup and configuration, please see our knowledge base.

Earlier this year, we purchased the readme.com domain for our homepage. Starting today, the ReadMe dashboard is accessible at dash.readme.com!

We recommend updating your bookmarks and password managers to this domain today. The dashboard is still accessible via the old domain (dash.readme.io), but we'll begin redirecting starting next week.

The ReadMe API will still be accessible via https://dash.readme.io/api/v1 for the foreseeable future.

If you have any questions, please contact us at [email protected].

As part of the rollout of the Changelog and Custom Pages API, we had initially required a x-readme-version header. The Changelog and Custom Page objects are not versioned the same way that they are for standard Guide and API Reference pages and it created problems with existing data in the dashboard, so all versioning has been removed from these sets of endpoints.

Going forward, the x-readme-version header is no longer required for the Changelog and Custom Pages API. If you have any questions, please contact us at [email protected].

We're excited to announce a couple of new updates to the enterprise members' management section.

We've decided to display all of the providers in the dashboard. The types that we visualize are: "ReadMe" and "SAML", this will help admins identify where their users are coming from.

We've also built out a utility feature within SAML integrations (Auth0 only) that allows you to map group attributes from SAML to permissions within ReadMe projects. This will enable admins to do things like: "for a user belonging to this group, I want to provision them with these permissions (ReadOnly, Admin) for these projects". To get started on implementation for this feature, talk to your ReadMe CSM!

We released an iteration to Audit Logs for our enterprise projects! Here are some of the new features we're excited about:

• We've added the project column to the audit logs: though you can specify which project you want to filter by via the navigation, it was difficult to tell which log belonged to which project when viewing by "all".
• We've added the version column as well: but not all rows will have a version attached to them, since things like editing project-specific settings aren't version-specific.
• We now provide links when you are editing pages, so you can easily navigate to that page!

Hey there—just us, ReadMe, again! We've been hard at work polishing the way we display API parameters in our reference sections. The headliner here is an updated layout that's way more flexible, so your community has a great reading experience, even on smaller screens. (And so this doesn't happen anymore... )

Beyond that, we've overhauled array and object fields to simplify how we visualize complex groups of parameters. And we've added a pinch of contrast and a dash of color to make it easier to scan and distinguish between these various fields and groups at a glance. We hope you like the improvements!

We just released a GitHub Action for automatically syncing an API Spec file directly from a GitHub repo! GitHub Actions are packages you can include in your GitHub configuration that run whenever certain events happen--such as pushing code to master, opening a pull request, and many more.

With our GitHub Actions, you can automatically sync a Swagger or OAS file every time a commit is pushed to master, meaning you no longer have to worry about keeping your docs up to date.

It's super easy to get started! After you join the GitHub Actions beta at https://github.com/features/actions (GitHub just announced it will be generally available November 13th), you just need to copy one file to your repo, add in your ReadMe settings, and that is it!

You can read the docs here to get started: https://docs.readme.com/docs/automatically-sync-api-specification-with-github

Happy Halloween and happy syncing!

We’ve made a lot of changes to our dashboard to make things easier to find, and added more information about your project and ReadMe to the Project Dashboard! For more information about these changes, you can read our blog post: https://blog.readme.io/dashboard-fall-cleaning

Project Dashboard

The Project Dashboard is now a more dynamic place! You can see a quick glance of metrics for your project or API, as well as information about new features, tips and tricks, and higher level blog posts about documentation and APIs.

There are always cool new things being released and want to make sure we spread the word on all of it! This section will have all of the new features we release as well as tips and tricks on how each project can give the best documentation experience possible to their users. So stay tuned to that space and you are bound to learn something new!

Navigation Changes

We made changes to navigation in our dashboard to make it easier to reach the things used frequently. There are three main sections to the new sidebar: settings, content, and metrics. All configuration for your project will live in the top group with all settings that are usually setup once in the Configuration section.

The middle of the new sidebar contains all of the pages that contain the content. Each page maps to a different section of your public documentation and from there you can write content and modify settings for each. We’ve moved API Settings into the API Reference section so you can import an OAS file and edit the created pages all within the same place!

Lastly is all of your metrics, either about your documentation or data about your API usage (if you’ve setup Developer Metrics).

We hope these changes make it easier to get around. Don’t forget, you can always click the search button at the bottom of the sidebar (or press cmd/ctrl+k) to search for what you are looking for!

We have rolled out API endpoints for Changelog and Custom Pages! Starting today, you can programmatically view and make changes to your data for these two ReadMe modules.

Check out our API Reference for more info!

Today, we are fulfilling a much-needed customer feature request: customizing page metadata with an image, title, and description. You'll be able to customize the metadata with custom text and images using the new metadata editor modal.

Here are some samples of how cards look like on Twitter, Slack, and LinkedIn

Here is how you can start using it:

1. Go to a page/custom page/changelog of your choosing
2. Click on the downward chevron next to the "Update Doc" button (on the top right)
3. Click on "Edit Metadata"
4. Fill in the optional items and click on "Save"

To find out more about what this can do, you can check out our docs on it!