Merge pull request #63 from gerMdz/docss

GitBook: First Commit

README.md

@@ -1,3 +1,76 @@
+
+# What is MyProduct?
+
+{% hint style="info" %}
+**Good to know:** providing a brief overview of your product and its core use cases is a great place to start with product docs. Your product might seem obvious to you – you made it! However, to others, even folks who are trying your product after reading your site or getting a sales demo, it can still be unclear. This is your chance to clarify your product and set the right expectations!
+{% endhint %}
+
+Here are a couple of examples of succinct 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/)
+
+## Getting Started
+
+**Got 2 minutes?** Check out a video overview of our product:
+
+{% embed url="https://www.loom.com/share/3bfa83acc9fd41b7b98b803ba9197d90" %}
+
+{% hint style="info" %}
+**Good to know:** 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](https://loom.com) as a perfect example of a succinct feature overview.
+{% endhint %}
+
+### Guides: Jump right in
+
+Follow our handy guides to get started on the basics as quickly as possible:
+
+{% content-ref url="guides/creating-your-first-project.md" %}
+[creating-your-first-project.md](guides/creating-your-first-project.md)
+{% endcontent-ref %}
+
+{% content-ref url="guides/creating-your-first-task.md" %}
+[creating-your-first-task.md](guides/creating-your-first-task.md)
+{% endcontent-ref %}
+
+{% content-ref url="guides/advanced-permissions.md" %}
+[advanced-permissions.md](guides/advanced-permissions.md)
+{% endcontent-ref %}
+
+{% hint style="info" %}
+**Good to know:** 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 %}
+
+### Fundamentals: Dive a little deeper
+
+Learn the fundamentals of MyProduct to get a deeper understanding of our main features:
+
+{% content-ref url="fundamentals/projects.md" %}
+[projects.md](fundamentals/projects.md)
+{% endcontent-ref %}
+
+{% content-ref url="fundamentals/members.md" %}
+[members.md](fundamentals/members.md)
+{% endcontent-ref %}
+
+{% content-ref url="fundamentals/task-lists.md" %}
+[task-lists.md](fundamentals/task-lists.md)
+{% endcontent-ref %}
+
+{% content-ref url="fundamentals/tasks.md" %}
+[tasks.md](fundamentals/tasks.md)
+{% endcontent-ref %}
+
+{% hint style="info" %}
+**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them. Combine guides with this approach to 'fundamentals' and you're well on your way to great documentation!
+{% endhint %}
+=======
 ## Bienvenido a AlamedaCMS
 
 Cms básico, basado en Symfony para entornos con acceso ssh y pleno control del server (ej. VPS), incluye reservas ([payunpile][6]) y enlaces ([incalinks][7])
@@ -81,3 +154,4 @@ Uso [PhpStorm][5]
 [6]: https://github.com/gerMdz/payunpile
 [7]: https://germdz.github.io/incalinks/
 [8]: https://github.com/gerMdz/AlamedaCMS.git
+

SUMMARY.md

@@ -0,0 +1,29 @@
+# Table of contents
+
+* [What is MyProduct?](README.md)
+
+## Guides
+
+* [Creating your first project](guides/creating-your-first-project.md)
+* [Creating your first task](guides/creating-your-first-task.md)
+* [Advanced permissions](guides/advanced-permissions.md)
+
+## Fundamentals
+
+* [Projects](fundamentals/projects.md)
+* [Members](fundamentals/members.md)
+* [Task Lists](fundamentals/task-lists.md)
+* [Tasks](fundamentals/tasks.md)
+
+## Use Cases
+
+* [For Designers](use-cases/for-designers/README.md)
+  * [Figma Integration](use-cases/for-designers/figma-integration.md)
+* [For Engineers](use-cases/for-engineers/README.md)
+  * [GitHub Integration](use-cases/for-engineers/github-integration.md)
+* [For Support](use-cases/for-support/README.md)
+  * [Intercom Integration](use-cases/for-support/intercom-integration.md)
+
+## Extras
+
+* [Keyboard Shortcuts](extras/keyboard-shortcuts.md)

extras/keyboard-shortcuts.md

@@ -0,0 +1,5 @@
+# Keyboard Shortcuts
+
+{% 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 %}

fundamentals/members.md

@@ -0,0 +1,5 @@
+# Members
+
+{% hint style="info" %}
+**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
+{% endhint %}

fundamentals/projects.md

@@ -0,0 +1,5 @@
+# Projects
+
+{% hint style="info" %}
+**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
+{% endhint %}

fundamentals/task-lists.md

@@ -0,0 +1,5 @@
+# Task Lists
+
+{% hint style="info" %}
+**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
+{% endhint %}

fundamentals/tasks.md

@@ -0,0 +1,5 @@
+# Tasks
+
+{% hint style="info" %}
+**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
+{% endhint %}

guides/advanced-permissions.md

@@ -0,0 +1,5 @@
+# Advanced permissions
+
+{% hint style="info" %}
+**Good to know:** 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 %}

guides/creating-your-first-project.md

@@ -0,0 +1,13 @@
+# Creating your first project
+
+{% hint style="info" %}
+**Good to know:** 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 %}
+
+## The basics
+
+Projects are containers for task lists. Think of them as a library for everything your team needs to get done to complete or ship a project.
+
+## Creating a project
+
+Hit the big '+' button in your sidebar and select 'New Project' from the menu that pops up. Give your project a name, and you're good to go!

guides/creating-your-first-task.md

@@ -0,0 +1,5 @@
+# Creating your first task
+
+{% hint style="info" %}
+**Good to know:** 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 %}

use-cases/for-designers/README.md

@@ -0,0 +1,5 @@
+# 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 %}

use-cases/for-designers/figma-integration.md

@@ -0,0 +1,5 @@
+# Figma Integration
+
+{% 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 %}

use-cases/for-engineers/README.md

@@ -0,0 +1,5 @@
+# For Engineers
+
+{% 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 %}

use-cases/for-engineers/github-integration.md

@@ -0,0 +1,5 @@
+# GitHub Integration
+
+{% 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 %}

use-cases/for-support/README.md

@@ -0,0 +1,5 @@
+# For Support
+
+{% 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 %}

use-cases/for-support/intercom-integration.md

@@ -0,0 +1,5 @@
+# Intercom Integration
+
+{% 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 %}