From 1c5346bd32b1e0aa2f04c1f453b51eeb1b5a3218 Mon Sep 17 00:00:00 2001 From: Reza Rahemtola Date: Fri, 8 Nov 2024 18:14:29 +0900 Subject: [PATCH] docs: README and basic introduction Fixes #56 --- README.md | 16 +++++++ docs/.vitepress/config.mts | 11 ++--- docs/api-examples.md | 49 ---------------------- docs/index.md | 11 +++-- docs/introduction.md | 23 +++++++++++ docs/markdown-examples.md | 85 -------------------------------------- 6 files changed, 48 insertions(+), 147 deletions(-) delete mode 100644 docs/api-examples.md create mode 100644 docs/introduction.md delete mode 100644 docs/markdown-examples.md diff --git a/README.md b/README.md index 4c9d0a3..6f7bee0 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ # Bedrock + +> Your private workspace by design, not by promise. + +Bedrock.im is a work-in-progress project that aims to offer an open-source and decentralized alternative to Workspaces solutions for individuals and companies.\ +Its features will include a complete drive to store your files privately, editors to allow you to manipulate your files in a confidential environment, and integrations with decentralized AI assistants, fine-grained permissions systems and anonymous subscriptions for paid services. + +Bedrock.im is a project built on top of [Aleph.im](https://aleph.im)'s decentralized cloud, supported by their [Acceleratooor](https://www.twentysix.cloud/acceleratooor/) program. + +As the project is still in it's early stages, ways to contribute and understand the technical architecture aren't properly documented yet and will gradually appear in [our documentation](https://docs.bedrock.im). + +If you're interested to learn more about this project, feel free to reach out by creating an issue, or contacting any of the team members below. + +## Team + +| [
Pablo Levy](https://github.com/chuipagro) | [
Florian Lauch](https://github.com/EdenComp) | [
Dorian Moy](https://github.com/Croos3r) | [
Reza Rahemtola](https://github.com/RezaRahemtola) +|:---:|:---:|:---:|:---:| diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 88de0d1..8074d01 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -16,15 +16,12 @@ export default defineConfig({ sidebar: [ { - text: "Changelog", - link: "/CHANGELOG", + text: "Introduction", + link: "/introduction", }, { - text: "Examples", - items: [ - { text: "Markdown Examples", link: "/markdown-examples" }, - { text: "Runtime API Examples", link: "/api-examples" }, - ], + text: "Changelog", + link: "/CHANGELOG", }, ], diff --git a/docs/api-examples.md b/docs/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/docs/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/docs/index.md b/docs/index.md index eb76c73..c5b48fb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,15 +4,14 @@ layout: home hero: name: "Bedrock.im" - text: "A VitePress Site" - tagline: My great project tagline + tagline: Your private workspace by design, not by promise. actions: - theme: brand - text: Markdown Examples - link: /markdown-examples + text: Introduction + link: /introduction - theme: alt - text: API Examples - link: /api-examples + text: Changelog + link: /CHANGELOG features: - title: Feature A diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..09a6faf --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,23 @@ +# Bedrock + +> Your private workspace by design, not by promise. + +Bedrock.im is a work-in-progress project that aims to offer an open-source and decentralized alternative to Workspaces +solutions for individuals and companies.\ +Its features will include a complete drive to store your files privately, editors to allow you to manipulate your files +in a confidential environment, and integrations with decentralized AI assistants, fine-grained permissions systems and +anonymous subscriptions for paid services. + +Bedrock.im is a project built on top of [Aleph.im](https://aleph.im)'s decentralized cloud, supported by +their [Acceleratooor](https://www.twentysix.cloud/acceleratooor/) program. + +As the project is still in it's early stages, ways to contribute and understand the technical architecture aren't +properly documented yet and will gradually appear in [our documentation](https://docs.bedrock.im). + +If you're interested to learn more about this project, feel free to reach out by creating an issue, or contacting any of +the team members below. + +## Team + +| [
Pablo Levy](https://github.com/chuipagro) | [
Florian Lauch](https://github.com/EdenComp) | [
Dorian Moy](https://github.com/Croos3r) | [
Reza Rahemtola](https://github.com/RezaRahemtola) +|:---:|:---:|:---:|:---:| diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md deleted file mode 100644 index f9258a5..0000000 --- a/docs/markdown-examples.md +++ /dev/null @@ -1,85 +0,0 @@ -# Markdown Extension Examples - -This page demonstrates some of the built-in markdown extensions provided by VitePress. - -## Syntax Highlighting - -VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: - -**Input** - -````md -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` - -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).