Skip to content

kube-tarian/compage-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What is Compage?

What's with the name?

"Compage" is a Latin word, translates into "Framework" in English.

{% hint style="info" %} Low-Code/No-Code framework for auto-generation and customization of the code base. Compage helps Developers to follow the industry standards and best practice methods like openAPI, CloudEvents, Software Supply Chain Security, AI/ML, etc. while empowering Developers to easily adopt different programming languages, frameworks, tools, methods, techniques, etc. Compage helps Organizations to reduce skill debt and improves project(s) timelines. {% 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

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

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 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 {% endcontent-ref %}

{% content-ref url="guides/creating-your-first-task.md" %} creating-your-first-task.md {% endcontent-ref %}

{% content-ref url="guides/advanced-permissions.md" %} 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 {% endcontent-ref %}

{% content-ref url="fundamentals/members.md" %} members.md {% endcontent-ref %}

{% content-ref url="fundamentals/task-lists.md" %} task-lists.md {% endcontent-ref %}

{% content-ref url="fundamentals/tasks.md" %} 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 %}

Releases

No releases published

Packages

No packages published