Skip to content

Commit

Permalink
introduction documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hasith committed Aug 31, 2024
1 parent 0aab265 commit 48ca671
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 20 deletions.
77 changes: 58 additions & 19 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,72 @@ layout: home
nav_order: 1
---

This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
# Welcome to Productled

If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
Productled is an open-source Product-Led Growth (PLG) platform designed to accelerate the growth of your web applications by enhancing user acquisition, activation, retention, revenue, and referrals—the core metrics known as AARRR Pirate Metrics. Whether you're a startup looking to scale or an established company aiming to optimize your product's performance, Productled provides the tools and flexibility you need to implement a PLG strategy effectively.

More specifically, the created site:
## Why Productled?

- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
In the modern digital landscape, product experience is a critical driver of growth. Productled enables you to build and refine user-centric experiences that drive sustainable growth by focusing on the following key areas:

Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
- **User Acquisition**: Simplify onboarding and increase user adoption with tools designed to streamline the first-time user experience.
- **User Activation**: Guide users to their "aha moment" faster, ensuring they see the value in your product quickly.
- **Revenue**: Implement and manage subscription models, pricing plans, and in-app purchases to drive monetization.
- **Retention**: Keep users engaged with features that encourage repeated use, such as in-app announcements, feedback loops, and personalized experiences.
- **Referrals**: Amplify growth by turning satisfied users into advocates who refer others to your product.

[Browse our documentation][Just the Docs] to learn more about how to use this theme.
## Robustly Built for Flexibility

To get started with creating a site, simply:
Productled is built with flexibility and scalability in mind, offering a range of features that can be customized to meet the unique needs of your product:

1. click "[use this template]" to create a GitHub repository
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
- **Modular Architecture**: Choose the components and plugins that fit your specific use case, integrating seamlessly with your existing stack.
- **Easy Integration**: Productled is designed to be easy to integrate into your web application, regardless of the technologies you use.
- **Extensible Plugins**: Extend the platform’s capabilities with plugins for spotlights, in-app messaging, user analytics, and more.
- **Open Source**: Being open-source means that Productled is community-driven, with continuous improvements and contributions from developers worldwide.

If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
## Plugin Ecosystem

----
Productled is designed to be highly extensible through its growing list of plugins, which you can easily integrate to enhance your application’s functionality. Below is a list of the currently available plugins:

[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
### 1. **Spotlights Plugin**

[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
This plugin allows you to create in-app spotlights that guide users through key features of your application. Spotlights can be used to highlight important UI elements or to create onboarding tours for new users.
[GitHub: @productled/spotlights](https://github.com/99x-incubator/productled/tree/main/packages/spotlights)

### 2. **Progress Plugin**

Track user progress within your app with the Progress Plugin. This plugin allows you to create visual progress bars, step trackers, and other user engagement tools to help users stay on track as they navigate through key experiences in your product.
[GitHub: @productled/progress](https://github.com/99x-incubator/productled/tree/main/packages/progress)

### 3. **Checklists Plugin**

This plugin helps you create and manage in-app checklists for user tasks, onboarding steps, or feature discovery workflows. It's ideal for guiding users through complex processes or ensuring they complete all the necessary steps for activation.
[GitHub: @productled/checklists](https://github.com/99x-incubator/productled/tree/main/packages/checklists)

### 4. **Modals Plugin**

The Modals Plugin allows you to add customizable modal dialogs within your app. Use modals to display critical information, onboarding tips, or important notices that require user interaction.
[GitHub: @productled/modals](https://github.com/99x-incubator/productled/tree/main/packages/modals)

### 5. **Tooltips Plugin**

Tooltips are a great way to provide additional context or guidance to your users. This plugin allows you to add dynamic tooltips to your application to explain features, offer tips, or provide inline help.
[GitHub: @productled/tooltips](https://github.com/99x-incubator/productled/tree/main/packages/tooltips)

Each plugin is highly configurable and integrates seamlessly with the core Productled library. As the community grows, more plugins will be added to this ecosystem to enhance the product-led growth strategy.

## Getting Started

Ready to dive in? Head over to the [Installation Guide](./installation.md) to set up Productled in your project. Whether you're looking to implement one feature or leverage the full suite of tools, our documentation will guide you through every step.

## Community and Contributions

Productled thrives on community contributions. Whether you're a developer, product manager, or growth hacker, your insights and code can help make Productled better for everyone. Visit our [GitHub repository](https://github.com/99x-incubator/productled) to explore the source code, report issues, or contribute to the project.

## Support

Need help? Check out our [Support and FAQs](./support.md) for common questions or join our community discussions on GitHub to connect with other users and contributors.

---

Thank you for choosing Productled to power your growth journey. We’re excited to see what you’ll build!
4 changes: 3 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ nav_order: 2
---

# Installation Guide

{: .no_toc }

Welcome to the Productled Library Installation Guide. This guide will walk you through the process of setting up and configuring the Productled Library in your project. By following these steps, you'll be able to leverage the powerful features provided by Productled to enhance your application's user experience.

## Table of contents

{: .no_toc .text-delta }

1. TOC
{:toc}

## Install the Core Packages
## Install the Core Package

To get started, you need to install the core Productled library. This library is the foundation for all Productled functionalities.

Expand Down

0 comments on commit 48ca671

Please sign in to comment.