Skip to content

Commit

Permalink
add docs for private pages
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasfcosta committed Nov 28, 2024
1 parent 08828a7 commit 13af830
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 5 deletions.
7 changes: 7 additions & 0 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ We recommend that you either sign-up for the cloud or deploy it yourself. That w
>
Use keyboard shortcuts for convenience and speed.
</Card>
<Card
title="Private Documents"
icon="person-chalkboard"
href="./product/private-documents"
>
Allow users to create private documents. Ideal for individual scratchpads.
</Card>
</CardGroup>

## Settings and management
Expand Down
37 changes: 37 additions & 0 deletions docs/product/private-documents.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Private Documents
description: Allow users to create private documents. Ideal for individual scratchpads.
icon: person-chalkboard
---

You can enable private documents so that users can create their own private documents that are only visible to them.

This is helpful if you want to enable users to create their own "scratchpad" documents without polluting the workspace with temporary documents.

For more information about what happens when you toggle the "Private Documents" setting to "on" or "off", please read [its section on the settings page](/settings/workspace-settings#private-documents).

<Note>
This setting is only available on the professional and enterprise versions of Briefer.
</Note>

## How to enable private documents

Enable private documents by going to the workspace settings and toggling the "Private Documents" setting.

Once you toggle that setting to "on", a section called "Private" will appear underneath the "Pages" section in the sidebar. There, users can create and manage their own private documents.

If you turn this setting to "off", the "Private" section will disappear from the sidebar, and users will no longer be able to create private documents. Still, the old documents will still exist, but they won't be accessible.

## Moving private documents into your workspace

You can move private documents into your workspace so that others can see them. For that, you can simply drag and drop the private document to the workspace pages section.

When you do that, your document will cease to be private and the usual workspace permissions will apply to it

## Copying public documents into your private space

When you try to drag a workspace document into your private space, Briefer will create a private copy instead of moving the existing document.

<Tip>
You cannot move workspace documents themselves into your private space. If you wish to move a workspace document to your private space we recommend you to drag and drop it to create a private copy and then delete the original workspace document.
</Tip>
48 changes: 43 additions & 5 deletions docs/settings/workspace-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,47 @@ icon: gear

You can configure your workspace settings to customize your Briefer experience.

Right now, there are only a few settings available, but we're working on adding more. Here's what you can do:
Here's what you can do:

- Change your workspace's name
- Allow anyone whose email belongs to your organization's domain to join your workspace automatically
- Change the default assistant model (only available on the cloud)
- Add an OpenAI API key (only necessary on the open-source version)
## Change your workspace's name

This is the name that will appear in the top left corner of the app.

It helps users identify which workspace they're in, especially if they're part of multiple workspaces.

## Allow anyone at the owner's email domain join your workspace

If you enable this setting, anyone whose email belongs to your organization's domain can join your workspace automatically.

We recommend enabling this setting if you want to make it easy for your team to join your workspace.

The domain is determined by the email address of the workspace owner and will appear in the workspace settings.

<Note>
This setting is only available on the cloud version of Briefer.
</Note>

## Change the default assistant model

You can change the default assistant model that Briefer uses to suggest code and queries.

## Add an OpenAI API key (only necessary on the open-source version)

If you're using the open-source version of Briefer, you'll need to add an OpenAI API key to use the assistant.

After adding your key, no one else will be able to see it, and it will be stored securely.

## Private documents

You can enable private documents so that users can create their own private documents that are only visible to them.

This is helpful if you want to enable users to create their own "scratchpad" documents without polluting the workspace with temporary documents.
Once you toggle that setting to "on", a section called "Private" will appear underneath the "Pages" section in the sidebar. There, users can create and manage their own private documents.

If you turn this setting to "off", the "Private" section will disappear from the sidebar, and users will no longer be able to create private documents. Still, the old documents will still exist, but they won't be accessible.

Read more about private documents in the [Private Documents page](/product/private-documents).

<Note>
This setting is only available on the professional and enterprise versions of Briefer.
</Note>

0 comments on commit 13af830

Please sign in to comment.