flexprice / flexprice/flexprice-docs

Documentation Issue: Outdated and Inconsistent Docs

Open
#42 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
4
Forks
15
Avg merge
1d 13h
Merged PRs (30d)
27

Description

## Description
While going through the **Flexprice documentation**, I noticed that it is highly inconsistent and difficult to follow. The documentation differs significantly from the actual product behavior and features.

Even worse, several provided **screenshots do not match the current UI/product**, which makes the docs misleading instead of helpful.

## Problem
- Large discrepancies between the documentation and the actual product.
- Screenshots are outdated and do not reflect the current state of the system.
- Release updates are not being reflected in the docs in a timely manner.
- As users, we are forced to compare with older versions or external references just to understand how things work now.

## Why This Matters
- New users (and even experienced ones) get confused and waste time figuring out what is correct.
- Documentation should be a source of truth, not a guessing game.
- Outdated docs increase onboarding time, cause errors, and lower confidence in the product.

## Suggested Solution
- **Update documentation alongside each product release** so it always reflects the latest state.
- Ensure that **screenshots and examples match the current UI and behavior**.
- Provide a **changelog or versioned documentation**, so users know what has changed without needing to infer it themselves.
- Consider adding a **"last updated"** tag or version label on each doc page.

## Impact
Clear, accurate, and up-to-date documentation will:
- Improve user adoption and trust.
- Reduce confusion and support requests.
- Allow teams to focus on using the product effectively rather than deciphering differences between docs and product.

---

**Request:** Please prioritize keeping documentation updated with every release.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.