Supercharge Your GitBook Docs with Live, Real-Time Polls

Technical documentation is often a one-way street: you write it, and users read it. But what if your documentation could be interactive? What if you could gather feedback, survey your readers, and make your content a living, collaborative space?

Today, we're excited to bridge that gap by launching the Vaultrice Voting Integration for GitBook!

You can now add beautiful, real-time, and interactive polls directly into any GitBook page. It's the perfect way to engage your readers and gather valuable feedback right where they are.

From Static Pages to Interactive Experiences

The Vaultrice integration adds a new "Vaultrice Voting Widget" block to your GitBook editor. With just a few clicks, you can create and configure a poll without ever leaving GitBook.

This integration is powered by our @vaultrice/react-components library, which handles all the complexity of real-time data synchronization. When a user votes, the results are securely stored in Vaultrice and updated instantly for every other reader across the globe.

Common Use Cases

This opens up a world of possibilities for your documentation:

• Gather feedback on a new feature proposal right on the doc page.
• Let users vote on which tutorial you should write next.
• Quickly survey readers about the clarity of an article.
• Run engaging, fun polls for internal team documentation.

Getting Started in 3 Simple Steps

You can get your first poll running in under five minutes.

1. Get Your Credentials: Create a free Vaultrice account to get your projectId, apiKey, and apiSecret.
2. Install the Integration: Find and install the "Vaultrice Voting Integration" from here - and configure it.
3. Configure the Block: Add the "Vaultrice Voting Widget" block to any page, paste in your credentials, and write your poll questions.

That's it! Your interactive poll is now live.

A Note on Security

For enhanced security in a public-facing context like documentation, we highly recommend locking down your API key. Using Origin Restriction, you can ensure your key can only be used for requests coming from GitBook's integration service.

Simply add https://integrations.gitbook.com as an allowed origin in your Vaultrice project dashboard. This is a powerful way to secure your credentials, and you can learn more about it in our Security Documentation.

See It in Action: The i18next Documentation

We're thrilled that the popular internationalization framework i18next is one of the first to adopt this new integration. They are actively using it to gather feedback from their vast community of developers.

You can see the poll live in their documentation and cast a vote yourself!

See the live poll on i18next.com

Conclusion

We believe that documentation should be a living, breathing part of your product's ecosystem. By adding a layer of real-time interactivity, you can get closer to your users and build better products.

We can't wait to see the creative ways you use this to engage your readers.