-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ecb915f
commit 3a07d8a
Showing
14 changed files
with
350 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
slug: "/getting-started/concepts" | ||
title: "Concepts" | ||
--- | ||
|
||
To better understand Vrite, first get to know a few concepts behind how the platform works. | ||
|
||
## Organization | ||
|
||
### Content Pieces | ||
|
||
A content piece is a **structured JSON content** and related **metadata** taken together. You’ll likely spend a lot of time editing the content in Vrite’s _Editor_ and managing metadata in the _Content Piece_ side panel. | ||
|
||
### Content Groups | ||
|
||
Content groups group multiple content pieces together, and are represented in the dashboard as e.g. a Kanban column or a folder. You can nest them and reference their IDs when integrating with Vrite’s API. | ||
|
||
### Workspaces | ||
|
||
Content pieces, content groups, members and related settings are all part of a workspace. You can create and join multiple workspaces to better manage your work (e.g. creating separate workspaces for different websites or projects) | ||
|
||
### Variants | ||
|
||
Apart from the _Base_ content pieces, you can also create multiple _variants_ of them. Variants allow you to better organize related content, like i18n translations, and other kinds of adaptations. Until metadata or the content of the variant is edited, it’s shared with the base content piece. | ||
|
||
## UI | ||
|
||
### Main Panel | ||
|
||
Main panel is where the bulk of the content creation and mangement work is done. Currently, the main panel is used for the dashboard, editor and Git sync conflict-resolution. | ||
|
||
### Side Panel | ||
|
||
Side panel is a resizable area to the left of the main panel. It’s meant for secondary activites, like managing content piece metadata, settings, extensions, Git sync etc. | ||
|
||
### Sidebar | ||
|
||
Sidebar is the primary mean of navigation around Vrite. The options to the top navigate both the main and side panel, while the ones to the bottom — only the side panel. | ||
|
||
## API & Customization | ||
|
||
### Input/Output Transformers | ||
|
||
Input and output transformers are an important part of the Vrite JavaScript SDK and the Git sync integration. | ||
|
||
**Output transformers** help transform the content piece’s data to necessary output formats, like HTML or JSX tree for your frontends, or Markdown file when syncing with a Git repo. | ||
|
||
**Input transformers** are currently meant exclusively for Git sync and help transform incoming files (e.g. Markdown, MDX, etc.) to HTML string and JSON metadata that can be loaded into Vrite. | ||
|
||
### Extensions | ||
|
||
The extensions are the primary way of extending the capabilities of Vrite’s platform. With direct access to both Vrite’s REST API and additional functions for customizing UI, they can be used to extend the editor, add easy publishing options and facilitate content synchronization with other platforms. | ||
|
||
<Info> | ||
While in Beta, the **Vrite Extension System** is in development and currently limited to first-party extensions available only through Vrite Cloud. | ||
</Info> |
44 changes: 44 additions & 0 deletions
44
apps/docs/src/content/docs/getting-started/introduction.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
slug: "/getting-started/introduction" | ||
title: "Getting Started" | ||
--- | ||
|
||
Vrite is an [open-source](https://github.com/vriteio/vrite), collaborative developer content platform to create, manage, and deploy product docs, technical blogs, and knowledge bases. | ||
|
||
<Important> | ||
Vrite is currently in Public Beta. | ||
</Important> | ||
|
||
<CardGrid> | ||
<Card | ||
link="/usage-guide/introduction" | ||
icon="mdi:lightbulb" | ||
title="Usage Guide" | ||
> | ||
Get started with using Vrite | ||
</Card> | ||
|
||
<Card | ||
link="/javascript-sdk/introduction" | ||
icon="mdi:javascript" | ||
title="JavaScript SDK" | ||
> | ||
Learn how to build with Vrite’s JavaScript SDK | ||
</Card> | ||
|
||
<Card | ||
link="/api/introduction" | ||
icon="mdi:api" | ||
title="API Reference" | ||
> | ||
Reference for Vrite’s REST API | ||
</Card> | ||
|
||
<Card | ||
link="/recipes/introduction" | ||
icon="mdi:text-box-multiple" | ||
title="Recipes" | ||
> | ||
Jump right into Vrite with ready recipes. | ||
</Card> | ||
</CardGrid> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.