Hello and happy Aries season, y'all! Lots of little improvements and bug fixes were released this week. Details below! โ™ˆ

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • Weโ€™ve added the a setting in the dashboard for enabling includeSubDomains parameter for the HSTS response header. You can configure this in the same place you configure your custom domain. ๐ŸŒ
  • Weโ€™re in the process of rolling out our new Enterprise Authentication experience! This release includes more work on that front. Get the details on everything here! ๐Ÿ”‘
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of inย our discussion forums! โœ๏ธ
  • Added a new global CSS class for the โ€œLog Inโ€ button in the top-right corner of the hubs. ๐ŸŽจ

๐Ÿ›  Fixes & Updates

  • Weโ€™ve received some feedback that the page voting thumbs can be a bit confusing to interact with, so this release includes improvements on that front. Feel free to check out a demo of the improved behavior in our docs! And if you found the page helpful and/or youโ€™re looking to play with the new behavior yourself, maybe give the page a thumbs-up? ๐Ÿ‘
  • Thereโ€™s a setting to hide the Table of Contents, but the API Reference has continued to exist on a chaotic plane and in complete disregard of this setting. This release brings the API Reference back down to earth. ๐ŸŒ
  • For Enterprise projects with lots of child projects (weโ€™re talking over twenty projects), this release includes improvements to the search modal so it can better filter for content across all your projects. ๐Ÿ”
  • Made a few improvements to our security scheme processing logic in the API Reference so hitting the โ€œTry It!โ€ button will work, even if the security scheme is incorrectly defined. ๐Ÿ”’
  • Fixed an issue where certain email notifications for Suggested Edits included broken links. ๐Ÿ”—
  • Fixed some server-matching issues when populating endpoints for Metrics. ๐Ÿ“ˆ
  • This release includes even more fixes to Page History for Custom Pages. โŒ›

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello and welcome to another weekly update! We continue to recycle pop culture references and remain heads down on some big upcoming projects, but in the meantime we're shipping a new API endpoint and rolling out our new Enterprise Authentication experience. Details below! โ™ป๏ธ

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • For some time now, weโ€™ve had an endpoint in the ReadMe API so you can programmatically apply for a job with us. Weโ€™ve made some behind-the-scenes improvements to that endpoint, along with an in-front-of-the-scenes improvement in the form of a new endpoint for retrieving all of our open roles! You can find the new endpoint documentation here. ๐Ÿ“ฎ
  • Building off our API Reference support for callback objects and the deprecated keyword comes support for... deprecated callbacks! Now, when the callback objectโ€™s inner Operation object has the deprecated field set to true, weโ€™ll properly surface that information to the user. ๐ŸŒ
  • Weโ€™re in the process of rolling out our new Enterprise Authentication experience! This release includes more work on that front. Get the details on everything here! ๐Ÿ”‘
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of inย our discussion forums! โœ๏ธ
  • General styling and language improvements in our API reference documentation. โœ๏ธ
  • Small accessibility improvements for mobile users. ๐Ÿ“ฑ

๐Ÿ›  Fixes & Updates

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

๐Ÿšง

This is a Staged Rollout!

We're rolling out this new experience to current Enterprise customers over the next few weeks to ensure a smooth transition. You'll get an Intercom notification in your dashboard when the functionality is live for your group. If you have any questions don't hesitate to reach out directly to your Product Experience Manager!

Making sure all of your team members and customers have the permissions to properly access your ReadMe docs? That's a... (ahem) major key to success*, folks. ๐Ÿ”‘

When it comes to managing your Enterprise Group, there can be a lot of moving partsโ€”multiple projects to oversee, lots of eyes on various parts of your docs, and team members and customers requiring different permission levels depending on how they need to interact with your projects. While we love the idea of you sharing your docs with the world, we want to make that sharing experience one that instills confidence rather than confusion. Youโ€™ve put enough energy into making your docs beautiful, personalized, and interactive, let us take care of making sure that you can manage your ReadMe projects and teams with ease.

On that note, over the last year weโ€™ve been tinkering away at making our Enterprise authentication and access management experiences more intuitive, and well, better ๐Ÿ˜Ž We're excited to share that these features are nowโ€ฆlights, camera, actionโ€ฆLIVE for all Enterprise customers! โœจ

The Scoop ๐Ÿจ

First, the sidebar in your Enterprise Group dashboard is looking a little different ๐Ÿง We heard from our Enterprise Group Admins that itโ€™s challenging to manage permission settings, especially when managing multiple projects within an Enterprise Group. We also got feedback that bulk inviting individuals to projects, whether they were technical writers needing to access some but not all project dashboards, or customers who needed hub-side access to private docs, was cumbersome and frustrating at times. So we set out to upgrade all of that.

To make it easier to distinguish between user roles, the former, unified Members page in your dashboard is now two separate sections: (1) Teammates and (2) End Users.

Teammates are members of your team who manage (e.g. write, edit, update) documentation related to your projects. End Users are consumers of your projectsโ€™ documentation whom youโ€™d like to grant hub-side only access to.

Teammates and End Users have unique needs, and now weโ€™ve created more distinct user permission settings that better map to how you want your team members and customers to interact with your docs. For both of these new user roles weโ€™ve simplified the login configuration and added increased functionalities around managing login methods, access privileges, and default user permissions. This distinction also allows us to keep building more secure and user-friendly docs for both user functions ๐Ÿ‘

For some of our Enterprise Admins, it was a headache to manually manage Read Only and Admin permission levels for dozens of users across dozens of projects. So to allow for easier team and multi-project management at scale, the new End User Management page simplifies the process of bulk inviting users to projects and more clearly delineates what projects End Users have access to.

Thereโ€™s also a new Projects page that makes it easier for Enterprise Group Admins to manage multiple projects at the group level. In this page you can see what projects are associated with an Enterprise Group, as well as add, remove, and/or make projects public or private.

Ray from our team recorded this live walk-through to highlight the new updates weโ€™ve made ๐Ÿ“น

And hereโ€™s a li'l breakdown of everything thatโ€™s changed:

NEW FeaturesImprovements + Updates
Teammates Page with new settings:
- Whatโ€™s it all about: where to configure access and invite users from your team (e.g. your company)
- The Domain Safelist dropdown allows you to set a domain and allow anyone with an email address at that domain to create a ReadMe account
- Login and authentication configurations including SSO dropdown + enforcement settings allowing Enterprise Group Admins to determine how they want Teammates to sign in to ReadMe
- Default permission level settings for new invited Teammates
- A new method for inviting teammates and assigning permission levels, as well as new permission levels to choose from (Group Admin, Group Viewer, Custom)

New End Users pages:
- (1) End User Login page with ability to configure the login method for your private docs (hub-side access)
- (2) End User Management page with ability to see and filter users that have access, and bulk invite new users

Projects Page to manage multiple projects within an Enterprise Group
- The Manage Projects button allows Group Admins to add or remove projects
- See all child projects in one centralized place and set as Public or Private
- Unified view for user permissions
- Clearer visibility into usersโ€™ roles
- Ability to filter Teammates by permission level and project access
- Redesigned UI for seeing private vs. public projects
- One consolidated UI for configuring hub-side login access

You can read more about this new experience in this overview guide. We hope youโ€™re excited for these updates! Weโ€™d love to hear from you, whether to share your feedback, ask a question, or just say hello. Feel free to click the Intercom widget to leave a message or send a note to [email protected] :owlbert:

*What's a long-form piece of content on authentication without a DJ Khaled reference?

Hello and welcome to our first full week of March, friends! This week, we're shipping v7.0.0 of rdme, syntax highlighting support for an additional language, and an owl fact. More below! ๐Ÿš€

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

๐Ÿ›  Fixes & Updates

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello and welcome to another weekly update! We're making headway on some big projects and making some big improvements to our GitHub Actions support. Details below! ๐Ÿ™

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • Weโ€™ve added first-class GitHub Actions support to our good friend rdme: ReadMeโ€™s official CLI (and as of this week, GitHub Action)! You can sync OpenAPI definitions, you can perform pre-upload OpenAPI validation, and even sync directories of Markdown filesโ€”all within an automated GitHub workflow. As part of this, weโ€™ve officially parted ways with our legacy GitHub Action. Check out our new docs page (which, I should add, is synced from the rdme GitHub repo using the rdme GitHub Action) to get the details! ๐Ÿ”„
  • Asย previously mentioned, weโ€™ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. Weโ€™ve made some major improvements and weโ€™ve begun rolling this out to Enterprise projects! This release includes even more work on this front. ๐Ÿ‘ฅ
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of inย our discussion forums! โœ๏ธ

๐Ÿ›  Fixes & Updates

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello and welcome to another weekly update! We had a short week due to a company holiday and we're heads down on a few exciting upcoming projects (stay tuned!), but just know that we finally fixed a bug that I identified the corresponding pop culture reference for weeks ago. More below! ๐ŸŽค

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of inย our discussion forums! โœ๏ธ

๐Ÿ›  Fixes & Updates

  • Although Damon was completely wrong about Taylor, he probably would have been onto something if he was accusing ReadMe documentation writers of being miscredited for their work... because that was the case, at least for a little bit! For a short period of time, our Page History records were incorrectly always attributing the author of the edits to the person who created the page. While weโ€™re unable to do anything about Mr. Albarnโ€™s Twitter ratio, this release includes a fix so page history going forward should reflect the correct songwriโ€”I mean, author. ๐Ÿฆ

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Happy Week of Valentines Day, y'all! Seeing as our collective love languages are acts of service and words of affirmation*, this release delivers just that. More below! ๐Ÿ’•

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • Asย previously mentioned, weโ€™ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. Weโ€™ve made some major improvements and weโ€™ve begun rolling this out to Enterprise projects! This release includes even more work on this front. ๐Ÿ‘ฅ
  • This release adds some much-anticipated endpoints to the ReadMe API: you can now create, edit, and delete categories via our API! It wouldnโ€™t be a ReadMe API announcement without a link to our endpoint docs, so be sure to check those endpoints out here! ๐Ÿ—„๏ธ
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of inย our discussion forums! โœ๏ธ
  • Minor accessibility improvements in the search results, which should make it easier to open results in a new tab. ๐Ÿ”

๐Ÿ›  Fixes & Updates

  • Weโ€™d like to give a quick shout out to the response sections in the API Reference that refuse to conform to the societal norm of numerically sorting their response codes. 200s, followed by 500s, followed by... 400s?! This is bold and brave stuff, y'all. We see you and we appreciate you! And we fixed an edge case where your response titles were getting a little mixed up. ๐Ÿ”€
  • Fixed a few enterprise-related quirks that caused our Slack integration to not send messages in certain circumstances. ๐Ÿ“ฅ
  • This release fixes some long-standing issues with PDF generation. ๐Ÿ“
  • Fixed a couple quirks with the creation of Recipes. ๐Ÿง‘โ€๐Ÿณ

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe Team :owlbert:

*(and probably all of them, in some capacity)

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our _Owlet Weekly Update**โ€”an _owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello and welcome to another Owlet Weekly Update, friends! We have a bit of a lighter release this week, but we continue to build on our mission of ensuring that buttons and links take you to all of the correct places. Details below! ๐Ÿ”—

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • Asย previously mentioned, weโ€™ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. Weโ€™ve made some major improvements and our beta is now underway! This release includes even more improvements to this beta. If you're an Enterprise project administrator and you're curious about what we've been working on, weโ€™d love for you to try it out! Drop us a line atย [email protected]. ๐Ÿ‘ฅ

๐Ÿ›  Fixes & Updates

  • There were certain situations where the โ€œClear Responseโ€ button in the API Reference wouldnโ€™t do its one job of clearing responses. Thankfully, this release fixes that! ๐Ÿšฎ
  • Fixed an issue in the API Reference where arrays werenโ€™t properly displaying their children if the children were certain polymorphic objects. ๐Ÿšธ
  • A few minor Windows-friendly copy edits in certain places. ๐ŸชŸ
  • A few small routing fixes for Enterprise projects. ๐Ÿงญ

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe Team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello and happy Winter Olympics season, y'all! To celebrate, we're shipping a luge huge list of fixes and improvements, including a minor tweak to a curl code sample. See what I did there? I tried to think of puns for everything else we shipped, but it went... downhill from there. Let's shred some gnar! (I'm so sorry) โ›ท๏ธ

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • As previously mentioned, weโ€™ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. Weโ€™ve made some major improvements and our beta is now underway! This release includes even more improvements to this beta. If you're an Enterprise project administrator and you're curious about what we've been working on, weโ€™d love for you to try it out! Drop us a line at [email protected]. ๐Ÿ‘ฅ
  • As previously announced, weโ€™re in the early stages of our GraphQL beta! This release includes additional work on that front. If your API is powered by GraphQL and are interested in helping us build the best GraphQL developer experience in the game, get in touch at [email protected]! ๐Ÿ“ˆ
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of in our discussion forums! โœ๏ธ
  • This release includes clearer validation error messages for certain OpenAPI file edge cases (i.e. complex response header definitions). โšฝ
  • We now do a better job of handling tag data in OpenAPI file in certain cases (e.g. empty tags, whitespace, etc.). ๐Ÿท
  • Posts from your discussion forum are now included in project clones. โ™Š

๐Ÿ›  Fixes & Updates

  • Rewriting history is usually not a good thing! This is true in a lot of contexts, but the one we're referring to is with our search modalโ€”there was a bug where clicking on a search result and then clicking the Back button in your web browser skipped over the page you were on. Thankfully, this behavior was fixed in this release. ๐Ÿ”
  • Fixed certain rendering behavior in the API Reference for additionalProperties fields in response object definitions. โŒจ๏ธ
  • Fixed an issue in the API Reference where certain polymorphic inputs werenโ€™t properly displaying their default values. ๐Ÿ” 
  • Fixed an issue where variables and glossary items were unable to handle certain special characters. ๐Ÿ”ข
  • Fixed an issue where certain logo link configurations werenโ€™t working properly. ๐Ÿ”—
  • Fixed one of our example cURL commands in the dashboard. ๐ŸฅŒ
  • Minor fixes to scroll-to-top behavior for certain URLs. ๐Ÿ“œ

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe Team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

Hello! I'm coming to you shortly after learning that Rihanna is pregnant so I am physically unable to write an introduction about anything else. Anyways, enjoy this week's Owlet Weekly Update! โ˜”

๐Ÿ‘

We've been rolling out a redesigned docs experience for some time nowโ€”check out this page for the details!

The legacy docs style is now deprecated and is not receiving any bug fixes. All changes below are only applicable to the new docs experience (unless otherwise noted). We'll communicate a sunset timeline to any remaining legacy customers soon.

โœจ New & Improved

  • As previously mentioned, weโ€™ve been hard at work re-thinking how Enterprise admins distinguish between user roles and how to simplify the process of managing multiple projects at scale. Weโ€™ve made some major improvements and our beta is now underway! This release includes even more improvements to this beta. If you're an Enterprise project administrator and you're curious about what we've been working on, weโ€™d love for you to try it out! Drop us a line at [email protected]. ๐Ÿ‘ฅ
  • Like many of you, weโ€™ve had our eyes on the GraphQL hype train for some time now. Well weโ€™re excited to announce that weโ€™ve officially finally entered the beta for our new GraphQL API Reference! Get the details on everything here. ๐Ÿ“ˆ
  • Now hereโ€™s a highly anticipated featureโ€”we now render an icon next to each of your search results to distinguish which section of your documentation each result is coming from! ๐Ÿ”
  • This release includes even more improvements to our soon-to-be-released editor, which you can get a sneak peek of in our discussion forums! โœ๏ธ
  • This release includes improved international support for variables and the glossary. ๐ŸŒ

๐Ÿ›  Fixes & Updates

  • Our file handling has been vastly improved in the API Reference! Hitting "Try It!" now does a far better job of preserving your file contents in multipart/form-data requests. As part of this, we've also added support for the explode and style parameters within the encoding object for multipart/form-data requests. ๐Ÿ—ƒ
  • Semi-related to the above, weโ€™ve also fixed a few edge cases around query string handling. ๐Ÿงต
  • This release includes various accessibility improvements to our modals throughout the product! You no longer have to deal with focus trapping issues and you can now consistently escape the modal using theโ€”you guessed itโ€”escape key. โŒจ๏ธ
  • Good news if youโ€™ve been a bit lazy to write response example valuesโ€”the API Reference now falls back to displaying the default value as an example if you donโ€™t include any examples. ๐Ÿ‚
  • If your API sends a simple boolean response, we previously used to display something like OK... but as of this release, we actually render the boolean value properly! ๐Ÿ†—
  • This release continues on last weekโ€™s response headers sans body work and brings better support to the response examples side of things. โšฝ
  • Iโ€™ve got 9,007,199,254,740,991 problems but the inability to handle large integers in the API Reference ainโ€™t oneโ€”at least as of this release. ๐Ÿ’ฏ
  • A few tweaks to prevent some jumpiness when navigating to the Landing Page. ๐Ÿฆ˜

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

โ€”Kanad and the ReadMe Team :owlbert:

๐Ÿ“˜

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Updateโ€”an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!