2021 Updates

27 Dec

  • New API Reference: Support for deprecated on operations.

19 Dec

  • New API Reference: Added support for Terms of Service and License.
  • New API Reference: We now show the API version next to the name.
  • New API Reference: Added support for named request examples of OAS3.
  • Change Code Block: On mobile displays, code lines will not wrap anymore so lines do not get cluttered.

16 Dec

  • New Variables: Allow exposing variables to window object for use in Custom HEAD Tags.
  • New Scripts/Styles: Allow disabling scripts and styles through URL for testing purposes.

11 Dec

  • Bug Fix Tables: Links having quotations in table paragraphs were not showing correctly after multiple edits.

08 Dec

  • Change Team: Default role for newly invited teammates is now Publisher instead of Admin.

03 Dec

  • New API Reference: Added support for the following constraints: maxLength, minLength, pattern, minimum, maximum and multipleOf.

02 Dec

  • New API: Added an API to find a page using slugs GET - Get page by slug.
  • New API Reference: Show enums for fields under request parameters

01 Dec

  • Bug Fix Editor: Inline code having backticks was losing formatting after two page saves.
  • Improvement Editor: Handling getting out of inline code just became much better when hitting right arrow or enter.

29 Nov

  • Improvement API: Page IDs are now shown in the UI under the page title at Sidebar > Page for your use on our APIs.

28 Nov

  • Bug Fix Images: Fixed bug where pasting images does not create an image block.

27 Nov

  • New API References: Added support for multiple server URLs.

24 Nov

  • New Custom HEAD Tags: onprojectloaded event gets triggered which lets you know when you can start modifying the layout of the docs.

22 Nov

  • New Templates: Ability to start from a template directly using template links.

18 Nov

  • New Synced Blocks: Reuse content with Synced Blocks.
  • Improvement Blocks: All margins for blocks have been standardised for a more consistent look.
  • Improvement Templates: Choose templates from a form that displays all the templates available including their content, rather than from a dropdown.
  • Change API: entityId of GET - Get audit log is a string, no longer an integer.

16 Nov

  • Bug Fix PDF Exports: Errors preventing PDF generation were not showing, if any.
  • Bug Fix PDF Exports: Exports used to break if there was an empty documentation.

15 Nov

  • New API References: Added support for readOnly and writeOnly.

11 Nov

  • New API References: Callbacks support.

09 Nov

  • New Custom HTML: Added Jupyter Notebook embedding instructions.
  • New API: Added an API to update pages.
  • Change API: Search Content API now also provides pageId in addition to the page name.
  • Bug Fix Custom HTML: Styles are no longer removed, but instead the Custom HTML contents would be enclosed in an iFrame.

05 Nov

  • New API Reference: Show OpenIDConnectURL for OpenID authentication schemes.
  • Bug Fix Version Picker: Version and section pickers used to show text cursor instead of pointer.

27 Oct

  • Change Custom Login: Variables are now injected in a vars object under payload.
  • Bug Fix Quick Switcher: Opening Quick Switcher before a version has loaded used to break the search.

26 Oct

  • Improvement Performance: Loading time for projects in the editor exponentially decreased for projects with many versions.
  • Improvement SEO: Robots hitting non-existent links will get 404.
  • Change Quick Search: Editor option to search through all versions is removed momentarily.

23 Oct

  • Bug Fix CSS: Right sidebar was falling below the search bar.

16 Oct

14 Oct

  • Bug Fix Mobile Layout: Index dropdown button and feedback controls were not aligned perfectly.

07 Oct

  • New CSS: Test CSS changes before deploying them to your readers.
  • Bug Fix Callout: Icons and badges in callouts were not being saved correctly.

06 Oct

  • Bug Fix Variables: Variables were not getting applied in code blocks.
  • Bug Fix Landing Page: Google analytics was not always firing event for landing page when returning from a page.
  • Bug Fix Landing Page: Browser URL when returning to landing page from a page was not updating.

04 Oct

  • Bug Fix Blocks: Adding blocks was not possible using the + sign on an empty line.

03 Oct

  • New Templates: Create page templates and apply on new pages.
  • Change CSS: Huge changes of how the editor is integrated were made (so we can enable further features), which lead to some CSS changes. CSS selectors which you might want to double check: app-documentation-content, .master > and .master-content.

20 Sep

  • New Embed: A non-minimal embed mode is now available.

14 Sep

  • New Search Analytics: Enterprise accounts can setup enterprise search analytics to segment data from different projects.

13 Sep

  • Security TLS: All our assets are now served over TLS 1.2 instead of TLS 1.1.

10 Sep

  • Change Code Blocks: Code blocks automatically collapse if it is larger than 100 lines. We also now expand the first line now rather than folding all lines.
  • Improvement Embed Mode: Table of contents and index are automatically hidden.

08 Sep

07 Sep

  • New Page History: Page history now follows through pages in cloned versions. This means that the creators and contributors will not be lost when a page is cloned, and that you'll be able to access previous versions from the cloned page as well as the original page.

06 Sep

  • New Page Linking: After choosing an API reference when page linking, you are now provided with a list of the operations for you to link to directly, rather than having to figure out the URL fragment.
  • Bug Fix API Reference: Fix to request bodies with root oneOf/anyOf not showing the table.

31 Aug

  • New API Reference: Nested oneOf/anyOf in request body now supported.
  • Bug Fix Version Cloning: Some documentation settings were not cloned to the new documentation when a version is cloned.

27 Aug

  • New Search Engine: Setup your docs site as a search engine on browsers.

26 Aug

20 Aug

  • New Page Details: See page creator from Sidebar > Page.

13 Aug

  • Bug Fix Font: Custom landing pages did not inherit the project font by default.

11 Aug

  • New Search: Enabled advanced search operators for our lightning-fast search.
  • Bug Fix API References: No longer show a collapsed table when requestBody is defined but empty.

10 Aug

  • New Read Page API: Added an API to read pages in Darkdown or text format.
  • New Users: Search through the team members list by name/email.

09 Aug

  • Bug Fix Page Linking: Links with specified titles having commas were causing the browser to hang.

07 Aug

  • New Organisation Search: Multi project search in a list fashion is available now for Enterprise plans.

29 Jul

  • New API: New API available to update version which allows you to publish and unpublish a version programmatically.
  • New Re-ordering Index: Re-arrange elements in a big index fast by entering the menu, click Re-arrange, and choosing a category to move it to.

26 Jul

  • Bug Fix Password Protection: Minority of customers who set up passwords before 2020 were unable to access anymore using the secure links they previously generated due to deprecation of the old system. The old system has been recovered now.

25 Jul

20 Jul

  • New Documentation Settings: You can now only show the date without the author in "Last Page Updated" section at the bottom of the page, without needing to modify CSS.
  • New Formatting: External links will now show a top-right pointing arrow in editor mode to indicate that they are external links, not internal links.
  • Bug Fix Audit: Deleting version was spamming the audit log with multiple entries.

13 Jul

  • Bug Fix Search: Search could fail due to expired search token if a user does not visit the landing page after the search token expires.

12 Jul

  • New Hosting: Host multiple projects under the same subdomain or custom domain.
  • Bug Fix Landing Page: Clicking on the logo to go to landing page did not change the URL.

29 Jun

  • Bug Fix Import/Export: Further fixes to new lines import/export for tables, as well as supporting new lines in table headers when importing.

23 Jun

  • New Formatting: Heading 4 is now available through all the different methods of formatting.
  • New UI Translation: French is now available as a pre-defined UI language.

21 Jun

  • Bug Fix Import/Export: Text between tags in tables was not exporting/importing correctly.

16 Jun

  • New History: We'll calculate and show you how many lines changed on every change so you know which edits are more signifcant.

15 Jun

  • Improvement Import: You no longer need to remove HTML tags when importing, we will sanitise it for you.
  • Bug Fix Pasting: Pasting images was not working with Chrome latest update.

13 Jun

22 May

  • Security TLS: Dropped support for the deprecated TLSv1.0 and TLSv1.1.

20 May

  • New Localisation: We added a guide for localisation.

  • New Formatting: Ordered lists now show different list type so you can reference items better, such as:

    1. This is first item, uses numbering.
      1. This is second item, uses lower alpha.
        1. This is third item, uses lower roman letters.
  • New Quick Search: Option to only search through current version.

  • New User Images: If you sign in with Google, you'll get your profile picture added on DeveloperHub.

  • Improvement SSO: If you're an SSO user on Google SAML, then if you click on Sign in using Google, we'll automatically sign you in using SSO.

  • Improvement Go To: Go To button now would not add the version slug if you were on the default version.

18 May

  • New Logout: When your logged in session expires, you can now log in back without losing what you're working on.
  • Security Feedback: XSS was possible through feedback message input. Feedback messages can no longer have markdown, as it is also a bit of an overkill.

17 May

  • New SEO: To disable search engine indexing, you can do it now from Project Settings directly.
  • New SEO: There are now Advanced Settings to canonicalise URLs without version slug for the default version, as well as to prevent indexing for older versions.
  • Bug Fix Access: Projects using custom domains were unable to load due to a security rule change. All functionality has been returned to normal now.

16 May

  • New Images: You can upload images directly by pasting them.
  • New Version Banner: Added an advanced setting to show a banner when the reader is viewing an older version.
  • Improvement Formatting: Place cursor correctly after outdenting a list.

14 May

  • New Formatting: Nested lists are now supported!
  • New Formatting: Continue numbering for ordered lists (only for first level).

9 May

  • Change CSS: Removed footer default margin.

3 May

  • New Feedback: Feedback is now enabled by default for all new projects.
  • Bug Fix Links: Having commas in the title of a link used to break a link.

29 Apr

25 Apr

  • New Feedback: Gather feedback from your readers right from the pages.
  • Change Search Analytics: Increase viewable analytics range to 30 days from 14 days.

15 Apr

  • New Cookie Consent: Cookie consent text can now be changed.
  • Change API References: Show "No Scopes" for OAuth2 flows with no scopes, and multiple CSS changes for OAuth2 definitions.

12 Apr

  • New Open in Editor: An edit button will be shown at the bottom right of your live docs when you use any of our Go To buttons in the sidebar.

10 Apr

  • New Require Annotation: Added a project setting to require that editors annotate changes.
  • New Open in Editor: Added a keyboard shortcut to open pages in editor when in live mode.

3 Apr

  • New Search Analytics: Find out how your readers are using search using Search Analytics.
  • New Page Contributors: Find the list of contributors on a page from Page details menu.
  • Bug Fix Index: Index rarely went out of sync, but no more.

1 Apr

  • Bug Fix Index: Drag/drop was too slow for big documentation. Now it is as fast as a one-page documentation!

31 Mar

  • Improvement Import: Clarify the error when a parent page is expected to exist but does not.

29 Mar

  • Bug Fix Cloning: Version cloning was failing if there is an API Reference in the version.

28 Mar

  • New Lock pages when editing: Added a project setting to lock page when editing to ensure data does not get overwritten by multiple people editing at the same time.

27 Mar

  • New User images: For your user profiles, you can now show your profile photo using Gravatar.

25 Mar

  • Improvement Performance: Loading project for your readers just went 4x faster for smaller projects and 10x faster larger projects 🔥
  • New API Reference: Ability to change the API Reference slug.

22 Mar

17 Mar

  • New Personalise Docs: Personalise the docs using injected variables.
  • Improvement Editor: Editor loading is now much faster for users with multiple projects.
  • Change API References: Disabled breaking words in tables.

16 Mar

  • New API References: Added Java OkHttp to available libraries for generating example requests.
  • New Annotate History: Add a message to page history to indicate what the change was.

10 Mar

  • New Image: Zoom image on click.
  • Bug Fix Table Resizing: Resizing grips were not showing when the column head had formatting.

8 Mar

  • New Duplicate Index: Duplicate pages, links, separators and categories right away from the index.
  • New CSS: Added active-category class to the currently active category.

5 Mar

  • New SSO: Sign in your users through your Identity Provider (IdP).

27 Feb

  • Improvement Cloning: When cloning a version, if any page had raw HTML, you will now be informed of the page title and documentation title of the offending page.

25 Feb

  • Bug Fix Editing: Writing HTML tag-like text in a page no longer can cause unexpected page rendering, such as <script>, <tag> or else.
  • Improvement General: You can no longer move from a page with unsaved changes in any way without confirmation

22 Feb

  • New API References: Support for generating examples for arrays as well as array items.
  • Bug Fix API References: Description was showing as default for requests.

20 Feb

  • New Tables: Table columns are now resizable.

18 Feb

  • New API References: Added support for default in parameters.
  • Change API References: No longer show headers table if there are no headers.
  • Change API References: Enhanced design for enum and default rendering.
  • Bug Fix API References: Fix to choosing OpenAPI-wide security schemes over operation overrides.
  • Bug Fix Index: When creating a page, the index scroll used to go back to the top.

17 Feb

  • New API References: Show request body description for requests, if any.

16 Feb

  • New API References: Headers and queries for the selected security scheme now shows in the example request.
  • Bug Fix Import: When an import file has two identical blocks, they used get associated to each other.

14 Feb

  • Change CSS: Font weight for inline code changed to 400 instead of 500. You can revert this change for your project by using .customise .inline-code{ font-weight: var(--fw-500); }.

9 Feb

  • New SEO: On pasting a documentation link on a social platform/slack/etc..., we'll preview the best image and description of the content possible.
  • New API References: Show response headers under responses.
  • New API References: Added C# HttpClient to available libraries for generation request examples.
  • New API References CSS: Add CSS selectors for each field in the tables.

8 Feb

  • Change Font: We have changed the default font to Nunito.
  • New Font: Customise font weights for your font.

6 Feb

  • New API References: Allow tags to expand.
  • New API References: Show endpoint operations next to tags when expandable.
  • New API References: Show enums for properties.
  • New API References: Tag links in the index are now clickable.
  • New API References: Request and response examples follow scrolling, making it easier for the reader to find the information they need.
  • Bug Fix Favicon: DeveloperHub icon no longer loads by default.
  • Change API References: CSS makeover, larger titles, more space.

4 Feb

  • Bug Fix API References: Fix example request hidden when request body has examples.
  • Bug Fix API References: All Go net/http were showing as GET requests in examples.
  • Bug Fix API References: Response body used to show the array item title as the title of the object.

3 Feb

  • New API References: Go net/http and PHP Guzzle are now available as libraries for generated request examples.
  • New Search: Search can now be opened using / Ctrl + K for readers.
  • Change Code Generation: Removed ability to choose which libraries are seen by your users. Majority of API References had all libraries enabled.
  • Bug Fix API References: Request and responses examples included the key value. Now it's removed.

2 Feb

  • New Help & Support: New Help & Support menu to reach our community discussions, report bugs and submit feature requests.
  • New API References: Requests have support for example under oneOf, anyOf, allOf.
  • New API References: Requests have support for showing the first example of examples.
  • New API References: Responses have support for showing all examples and having them selectable.
  • Bug Fix API References: Requests and responses that have an array of undefined type would show just array instead of array[undefined].
  • Bug Fix API References: Requests object title was not shown.
  • Bug Fix API References: Markdown rendering for big images could have overflowed the container.

31 Jan

  • New Edit History: Edit history now shows the differences in colours. You can also see the change between current edit and the published edit. Along that, we redesigned a bit the page history panel to focus on published edits rather than drafts.
  • Bug Fix Import/Export: We no longer show import/export options when viewing a page edit history as it was misleading.
  • Bug Fix Dashboard: Comment list was not scrollable if too long.
  • Bug Fix Compatibility: On Safari, project logo width could be miscalculated on same loads causing search bar to fall.

27 Jan

  • Bug Fix Activity Log: On reordering indices, there was no icon or good explanation of what happened.
  • Bug Fix API References: Fields other than Operation Objects under Path Item Object used to break an API reference.

24 Jan

  • New Audit: Enterprise customers can query audit logs using the API.
  • New Get All: All users can query all resources on DeveloperHub using API.
  • Change API Rate Limits: All APIs are rate limited.

19 Jan

  • New Publishing: Added a setting to prompt you if you are publishing a page that has unresolved comments.
  • New Comments: You can now resolve all comments on a page from the activity bar.
  • Improvement Page Linking: Search for page linking after typing "@" now searches through titles and slugs. It also tolerates typos.

16 Jan

  • Bug Fix Blocks: Duplicating a block more than once at the same time used to have unexpected results.
  • Bug Fix Table: The floating table options control used to float at the wrong place if a row had multiline input.

12 Jan

  • New Activity Log: View the latest changes right away from the dashboard.
  • Improvement Heading Selection: When linking a page, we'll automatically copy the heading title if a heading was selected and no title was chosen yet.
  • Bug Fix API Reference: API References were not delete-able from 11 Jan 2021.
  • Bug Fix Import: In case of an incomplete import due to error, we now delete the incomplete versions.

11 Jan

  • New CSS Changes: Added a CSS selector to apply CSS to select versions.

8 Jan

  • New Embed Mode: Add ?goto=embed when navigating to a page to enable embed mode.

7 Jan

  • Change User Roles: Publishers can no longer change project colours or top navigation links/icons.
  • Bug Fix Colour Picker: On opening the picker, it used to default colours even if settings were not explicitly changed.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated by Zaid Daba'een