Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skipthedragon/streamlined
📈 Connect your documentation to your application, simplifying the learning process for your clients.
https://github.com/skipthedragon/streamlined
javascript php symfony
Last synced: about 2 months ago
JSON representation
📈 Connect your documentation to your application, simplifying the learning process for your clients.
- Host: GitHub
- URL: https://github.com/skipthedragon/streamlined
- Owner: SkipTheDragon
- License: gpl-3.0
- Created: 2024-04-06T18:27:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T17:20:04.000Z (6 months ago)
- Last Synced: 2024-07-13T18:32:43.216Z (6 months ago)
- Topics: javascript, php, symfony
- Language: Twig
- Homepage: https://streamlined.demo.wyverr.com
- Size: 39.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simplified Connectivity: Bridging Documentation and Products
Crafting instructions and tutorials for your clientele consumes valuable time that could be allocated elsewhere. However, disregarding this aspect risks financial loss, which isn't conducive to business success. With Simplified Connectivity, just share a link and simplify your workload!
The code is in bundle/StreamlinedBundle. I added Symfony inside the repo just for easier testing and deploy.
# Demo
You can see the demo [here](https://projects.wyverr.com/streamlined).
## Local
To run the project locally,
you need to have [docker](https://docs.docker.com/get-docker/) and [lando](https://lando.dev/download/) installed.
Then after you have cloned the project, open your terminal and run the following commands:
```bash
cd streamlined/
lando start # This will start/fetch the docker containers, install the dependencies (yarn and composer) and migrate and seed manticore data
cd bundle/StreamlinedBundle/
lando yarn watch # This will build the assets in case they are not built already
```
Then access the website at [http://streamlined.lndo.site](http://streamlined.lndo.site).
## Website
Or just click the [link](https://projects.wyverr.com/streamlined) to the website.
## An Illustrative Example:
**Identified Issue:**
Consider the typical process of instructing users/customers to activate registration on their WordPress website. Typically, it entails the following steps (excerpted from an online source):
1. Log in to the Admin section of your WordPress.
2. Navigate to Settings > General.
3. Enable the "Anyone can register" option.
4. Save changes.
**Proposed Solution:**
Avoid verbosity and time wastage by utilizing the following concise method:
*Simply click: [](https://projects.wyverr.com/streamlined/pointing-to/wordpress/?pointer=sadas), and check the "Anyone can register" box.*
**Rationale:**
This approach streamlines the process, alleviating common user concerns such as uncertainty and missed steps.
**Additional Functionalities:**
- Automated form completion (where applicable)
- Auto-scrolling
- Text highlighting
Key Features:
- Compatible with various platforms (WordPress, WooCommerce, etc.)
- Reduces confusion, enhances customer satisfaction, and bolsters sales.
- User-friendly and simple installation.
- Translations
- Customizable
- Primarily designed for developers but accessible to all (requires minimal programming knowledge, mainly YAML).
## Inspired by HomeAssistant's "My HomeAssistant" tool: [https://my.home-assistant.io/](https://my.home-assistant.io/)