GitBook: No commit message

gitbook/README.md

@@ -0,0 +1,45 @@
+# 👋 Welcome to A Product
+
+{% hint style="info" %}
+**GitBook tip:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
+{% endhint %}
+
+## Overview
+
+Here are a couple of example overviews from products with really great docs:
+
+> Loom is a video messaging tool that helps you get your message across through instantly shareable videos.
+>
+> With Loom, you can record your camera, microphone, and desktop simultaneously. Your video is then instantly available to share through Loom's patented technology.
+>
+> — From the [Loom Docs](https://support.loom.com/hc/en-us/articles/360002158057-What-is-Loom-)
+
+> The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.
+>
+> — From the [Mailchimp Marketing API docs](https://mailchimp.com/developer/marketing/docs/fundamentals/)
+
+## Quick links
+
+{% content-ref url="overview/what-we-do.md" %}
+[what-we-do.md](overview/what-we-do.md)
+{% endcontent-ref %}
+
+{% content-ref url="overview/our-features.md" %}
+[our-features.md](overview/our-features.md)
+{% endcontent-ref %}
+
+## Get Started
+
+We've put together some helpful guides for you to get setup with our product quickly and easily.
+
+{% content-ref url="fundamentals/getting-set-up/" %}
+[getting-set-up](fundamentals/getting-set-up/)
+{% endcontent-ref %}
+
+{% content-ref url="fundamentals/getting-set-up/setting-permissions.md" %}
+[setting-permissions.md](fundamentals/getting-set-up/setting-permissions.md)
+{% endcontent-ref %}
+
+{% content-ref url="fundamentals/getting-set-up/inviting-members.md" %}
+[inviting-members.md](fundamentals/getting-set-up/inviting-members.md)
+{% endcontent-ref %}

gitbook/SUMMARY.md

@@ -0,0 +1,24 @@
+# Table of contents
+
+* [👋 Welcome to A Product](README.md)
+
+## Overview
+
+* [💡 What we do](overview/what-we-do.md)
+* [✨ Our Features](overview/our-features.md)
+
+## Product Guides
+
+* [📪 Making a post](product-guides/making-a-post.md)
+* [📎 Understanding Projects](product-guides/understanding-projects.md)
+
+## Fundamentals
+
+* [🛠 Getting set up](fundamentals/getting-set-up/README.md)
+  * [📝 Setting permissions](fundamentals/getting-set-up/setting-permissions.md)
+  * [🧑 Inviting Members](fundamentals/getting-set-up/inviting-members.md)
+
+## Use Cases
+
+* [🎨 For Designers](use-cases/for-designers.md)
+* [🖥 For Developers](use-cases/for-developers.md)

gitbook/fundamentals/getting-set-up/README.md

@@ -0,0 +1,33 @@
+# 🛠 Getting set up
+
+<details>
+
+<summary>Step1: Creating your organization</summary>
+
+
+
+</details>
+
+<details>
+
+<summary>Step 2: Inviting your team</summary>
+
+
+
+</details>
+
+<details>
+
+<summary>Step 3: Making your first post</summary>
+
+
+
+</details>
+
+<details>
+
+<summary>Step 4: Publishing a post</summary>
+
+
+
+</details>

gitbook/fundamentals/getting-set-up/inviting-members.md

@@ -0,0 +1,29 @@
+# 🧑 Inviting Members
+
+{% hint style="info" %}
+**GitBook tip:** Try out a range of different content types to keep folks engaged and interested in each feature, some content types work for different chunks of information
+{% endhint %}
+
+<details>
+
+<summary>As a Guest User</summary>
+
+
+
+</details>
+
+<details>
+
+<summary>As an Editor</summary>
+
+
+
+</details>
+
+<details>
+
+<summary>As an Admin</summary>
+
+
+
+</details>

gitbook/fundamentals/getting-set-up/setting-permissions.md

@@ -0,0 +1,11 @@
+# 📝 Setting permissions
+
+{% hint style="info" %}
+**GitBook tip:** your product docs aren't just a reference of all your features, use them to encourage folks to perform certain actions and discover the value in your product.
+{% endhint %}
+
+## Permission levels
+
+There are 4 types of permission levels in the product.
+
+<table><thead><tr><th width="180">Role</th><th>Capabilities</th></tr></thead><tbody><tr><td>Administrator</td><td>Has all admin privileges</td></tr><tr><td>Editor</td><td>Can edit posts</td></tr><tr><td>Viewer</td><td>Can only view posts</td></tr><tr><td>Guest</td><td>Can only view posts they are inivted to</td></tr></tbody></table>

gitbook/overview/our-features.md

@@ -0,0 +1,17 @@
+# ✨ Our Features
+
+{% hint style="info" %}
+**GitBook tip:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at Loom as a perfect example of a succinct feature overview.
+{% endhint %}
+
+## Awesome Feature One
+
+Get amazing things done with awesome feature one. But remember that awesome feature two and three exist too. In fact, Awesome Product is full of awesome features.
+
+![](https://images.unsplash.com/photo-1555774698-0b77e0d5fac6?crop=entropy\&cs=tinysrgb\&fm=jpg\&ixid=MnwxOTcwMjR8MHwxfHNlYXJjaHwyfHxhcHB8ZW58MHx8fHwxNjYwNTgzMzQz\&ixlib=rb-1.2.1\&q=80)
+
+## Awesome Feature Two
+
+Get amazing things done with awesome feature two. But remember that awesome feature one and three exist too. In fact, Awesome Product is full of awesome features.
+
+![](https://images.unsplash.com/photo-1569144157591-c60f3f82f137?crop=entropy\&cs=tinysrgb\&fm=jpg\&ixid=MnwxOTcwMjR8MHwxfHNlYXJjaHwxfHxmZWF0dXJlfGVufDB8fHx8MTY2MDU4MzM1OQ\&ixlib=rb-1.2.1\&q=80)

gitbook/overview/what-we-do.md

@@ -0,0 +1,11 @@
+# 💡 What we do
+
+{% hint style="info" %}
+**GitBook tip:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at Loom as a perfect example of a succinct feature overview.
+{% endhint %}
+
+## Video overview
+
+Got 2 minutes? Check out a video overview of our product:
+
+{% embed url="https://www.loom.com/embed/3bfa83acc9fd41b7b98b803ba9197d90" %}

gitbook/product-guides/making-a-post.md

@@ -0,0 +1,13 @@
+# 📪 Making a post
+
+## Step 1 - Start journalling
+
+Donec sed odio dui. Curabitur blandit tempus porttitor. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec ullamcorper nulla non metus auctor fringilla. Maecenas sed diam eget risus varius blandit sit amet non magna. Aenean lacinia bibendum nulla sed consectetur.
+
+![](https://images.unsplash.com/photo-1522881451255-f59ad836fdfb?crop=entropy\&cs=tinysrgb\&fm=jpg\&ixid=MnwxOTcwMjR8MHwxfHNlYXJjaHw0fHx3cml0ZXxlbnwwfHx8fDE2NjA1ODc5Nzk\&ixlib=rb-1.2.1\&q=80)
+
+## Step 2 - Create Post
+
+Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Maecenas faucibus mollis interdum. Cras mattis consectetur purus sit amet fermentum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Donec ullamcorper nulla non metus auctor fringilla. Nullam quis risus eget urna mollis ornare vel eu leo. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
+
+![](https://images.unsplash.com/photo-1515378791036-0648a3ef77b2?crop=entropy\&cs=tinysrgb\&fm=jpg\&ixid=MnwxOTcwMjR8MHwxfHNlYXJjaHw2fHxwb3N0fGVufDB8fHx8MTY2MDU4ODAzMg\&ixlib=rb-1.2.1\&q=80)

gitbook/product-guides/understanding-projects.md

@@ -0,0 +1,21 @@
+# 📎 Understanding Projects
+
+## How Projects work
+
+Nullam quis risus eget urna mollis ornare vel eu leo. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Maecenas sed diam eget risus varius blandit sit amet non magna. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec id elit non mi porta gravida at eget metus. Donec id elit non mi porta gravida at eget metus.
+
+### The Basics
+
+Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.
+
+Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
+
+### Creating a Project
+
+Nullam quis risus eget urna mollis ornare vel eu leo. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
+
+### Organizing your Projects
+
+Sed posuere consectetur est at lobortis. Curabitur blandit tempus porttitor. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui.
+
+Curabitur blandit tempus porttitor. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

gitbook/use-cases/for-designers.md

@@ -0,0 +1,21 @@
+# 🎨 For Designers
+
+{% hint style="info" %}
+**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
+{% endhint %}
+
+## Figma Integrations
+
+{% tabs %}
+{% tab title="Installing" %}
+{% embed url="https://www.figma.com/community/plugin/950514102619019349/Automater" %}
+{% endtab %}
+
+{% tab title="Configuring" %}
+Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+{% endtab %}
+
+{% tab title="Customizing" %}
+
+{% endtab %}
+{% endtabs %}

gitbook/use-cases/for-developers.md

@@ -0,0 +1,23 @@
+# 🖥 For Developers
+
+{% hint style="info" %}
+**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
+{% endhint %}
+
+## GitHub Integrations
+
+Cras mattis consectetur purus sit amet fermentum. Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
+
+{% tabs %}
+{% tab title="Installing" %}
+Sed posuere consectetur est at lobortis. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Aenean lacinia bibendum nulla sed consectetur. Maecenas sed diam eget risus varius blandit sit amet non magna.
+
+```
+string | ComponentClass<any, any> | FunctionComponent<any>
+```
+{% endtab %}
+
+{% tab title="Second tab" %}
+Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+{% endtab %}
+{% endtabs %}