1. GitHub

With GitHub you can write docs-as-code in Markdown files. It syncs automatically to an archbee collection where it can be shared internally with non-technical team members. On top of that, you benefit of the same public sharing mechanism as every other collection..

It's a one-way sync (from GitHub to Archbee) by design. We believe git as a system works great because there is a human interaction requirement — when merge conflicts arise, somebody will need to manually merge the content in the files. When one side of the system is automated (as it would be in our case if the integration would be 2-ways), a 2-way system would not be able to protect your content from being injured in the process.

You can then easily publish the collection to your domain, and combine it at will with WYSIWYG collections to build your docs sites.

Note: Our GitHub/git integrations are just at the beginning. We plan to create another editor block that references chunks of code in the repositories to let you document SDKs and keep them in sync with the code. Similarly to our Doc Verifications feature, the new block will prompt you when the code goes out of sync with the documentation in archbee. This will be a great feature to have when internally onboarding developers as well, allowing you to create sequences to take them through your codebase if necessary. This is one of our major features to launch next Q.

2. JIRA

Now you can paste JIRA issues after adding the integration, and they'll be automatically embedded in Archbee docs (and the content kept in sync). 

Our JIRA integration works well now, and we're looking to expand its capabilities based on your input. 

Happy documenting from the Archbee team!

Public docs authentication for your customers is hard in Archbee if you don't use the JWT integration.

It's hard to share a password with all the stakeholders. Especially when the password changes.

It's hard to manage accounts and passwords for the stakeholders.

With Magic Links you can now add their email address or their domain address, and they will be able to authenticate solely using their email. We just send them a link that authenticates them on click.

Here's how it looks like down below. 

Check out our docs for examples and details:

https://docs.archbee.io/expandable-headings

We just launched a new document site template, called Booklet.

Yes, it looks similar to a book and it enables us to provide you with nicely printed PDF versions of your collections.

Now the customers on your remote oil drilling platform are covered with this offline version. Just kidding, but PDF printing has been something many enterprise companies have been asking us for a while, and as you know by now, we listen.

How does it work?

Once you have your domain set for a collection and you enable the PDF feature in the collection settings, we automatically build a PDF version on each publish.

Here's a sneak peek out of our V1 docs: https://app.archbee.io/public/rQfz20MmRdainSGyL3VuF

On Saturday the 20th of November, 9:30 UTC we're taking the system offline to upgrade a few critical systems that need more capacity.

We anticipate up to one hour of downtime for the editor. The published doc sites will keep working uninterrupted at 100% capacity.

You'll get in return a faster, more reliable experience all around!

Knowledge in your team gets outdated, that's a fact.

With Archbee we make it easy for you to keep it up to date — with document verifications.

Select a subject matter expert from your team, and they'll be notified recurrently to check the content of the document.

Here's how it works.

Last week we launched Native OpenAPI for Archbee.

Why is this so awesome for you?

If your product is built for developers or your product has an API, you need great product documentation — otherwise, you can't cut through to developers.

How does it work?

We read your OpenAPI (formerly Swagger) spec files and convert it to a beautiful UI.

Then if you want to update it, you can upload new files manually or just set it up in your CI/CD to be updated automatically through our own API.

Then you keep it for internal purposes, or share it with your customers in just a couple clicks — or even set your own custom domain for 0 engineering effort product documentation.

Here's a video :)

We took our time on this update. But it was worth it! Here are the Updates.

Collection Links: multi-product & multi-version product docs sites

Here's how it works in our documentation (hint, our docs is already using the feature).

Stripey template & our template system are out of beta

We've seen 30% of the entire product website population migrate to the new Stripey template. You can do so in the collection settings.

Vertical Split

A new block has been developed, you can now split the screen vertically. To use it, type (vs) in the editor.

Link blocks

You can now add link blocks, each being formattable and each can have an image attached to it. To use it type (lb) in the editor.

Import from GitBook

Yes, many people asked us.

Import from Notion

Yes, many people asked us.

Import multiple Markdown files

Drag and drop as many .md files as you'd like in the same box, we'll convert them and drop them neatly in an archbee collection.

UI Improvements

• spacings, colors and more have been tightened all over the app;
• new @ mentions indicators, different from external links indicators;
• improved performance in the editor.

Lots more, but it's Sunday so I'm going to keep it short!

Happy documenting from the Archbee team!

Our WYSIWYG editor is nice, but sometimes people just prefer plain-old markdown in a git repo.

This is why with today's new feature, our GitHub App, will allow you to do exactly this.

HOWTO

1. Install our GitHub App in the integration settings and give it access to the repositories that will have the markdown content.

2. Create a new collection. Choose GitHub-backed and then select your repo.

3. Click ADD COLLECTION. We'll fetch the repo and the `/docs` by default.

Many configurations are available. Read up here: https://docs.archbee.io/github-beta

With this release you should also find more robust converters to Markdown everywhere they are used in the app.

Happy documenting! 🥳🎉