January 23, 2019
We’re very excited to announce that the SendBird Documentation is now redesigned, up-to-date, and even more intuitive.
Every month, thousands of individual developers and customers use our documentation to build incredible products, create projects, start side-hustles, or simply make communication easier in their web or mobile apps. Our new documentation page continues to deliver the same high standards of simple, intuitive, and helpful documentation to all the developers who depend on SendBird to build valuable communication into their app.
When you’re building on top of a communications platform, you want simple, instructive, and searchable documentation to help you when you most need it. While we received a lot of praise for our old docs page, we realize that, first, it didn’t cover all the neat features you could build with SendBird and, second, it could have disambiguated some particularly muddy sentences, definitions or terminology. Plus, with so much new content, we needed to provide better ways to search and locate the right information.
This granular level of detail could not have been updated without listening to our developer community. You are crucial to our success.
So without further ado, we’d like to present the update to our documentation page.
What’s new in the documentation?
- Two New Features: (1) Update to User Blocking (2) Hide or Archive Channel
- New and updated content in the SDK & Platform API guides with an emphasis on Platform API
- A search box prominently displayed at the top of the page
- New content navigator on the right for more intuitive browsing
- Better organized tables, so you can locate information more quickly
- New code block layout and background skin for better readability
- A gorgeous new font for better readability
- An FAQ on the main page for more common questions
New Features: Update to User Blocking and Hide or Archive Channel
Update to user-blocking
We used to have three modes for user-blocking: explicit, silent, and classic. Essentially, they allowed you to toggle on or off a blocked user’s awareness of being block and either update channel lists or not accordingly. By creating set modes, however, we restricted the flexibility for this feature.
Our update to user-blocking allows you to choose among three options:
- Display to users which users they blocked — ON/OFF
- Include blocked users in invitiations — ON/OFF
- Turn ON/OFF push notifications for blocked user messages
Hide or Archive Channel
You can now hide or archive channels in a channel list.
When you hide a channel, the channel disappears from the channel list and reappers when a new message is sent to the channel.
When you archive a channel, the channel disappears unless you unarchive it.
This new feature gives two choices:
- You can set the operating behavior of a channel to to automatically hide or archive
- You can set whether previous messages (sent before a hide or archive action) displays to users after the hidden channel reappears
You can also filter channels according to these properties.
Updated content in all SendBird SDK and Platform API guides
We also took great care to disambiguate SendBird into the SendBird server, SendBird application, and SendBird system, so it’s clear at all times to which the documentation refers.
Dive in and let us know what you think.
For the Platform API, we updated all the response samples, as well as some definitions, resource representations, and descriptions.
New ways to navigate the docs: the search and navigation bar
As our documentation began to add up, we wanted to ensure that our community could find the information it needed when it needed it. The past search was difficult to locate and less robust. So we placed our search front and center and adopted some stronger search technology.
The new navigation bar allows developers to navigate to more granular content. Before we had general intuitive categories on the left, but we didn’t segment this information adequately for readers. So we added a convenient navigation bar on the right to complement the left-side. In the new navigation bar, all the relevant section divisions bubble up to the top and you can immediately jump to any section.
Readability: New font, code-blocks, and tables
This article already displays many examples of the new font. But see it for yourself, if you haven’t had enough!
You’ve seen the updated response samples displayed in the new code-blocks. The new code-blocks (also pictured below) have a quick copy button in the top right, a toggle between the light and dark background, and color formatting for the text. All this means code that’s easier to read, understand, and use.
Like the new code-blocks, the tables now more clearly display information making it more readable and quickly understandable.
Conclusion: Good Docs, Good API
Thanks to our developer community, we’ve been able to continuously improve our docs, their content and readability. To an extent, an API is only as good as its documentation is helpful to developers. That’s our goal. Great docs. Great API.