Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Marketplace Analytics — documentation

Documentation set for the Marketplace Analytics platform: a REST API and dashboard that consolidates Wildberries and Ozon seller data into a single profit, inventory and conversion view.

Published site: https://b0gdaan.github.io/tw/

The documentation covers three audiences from one source tree:

Audience Entry point
Sellers setting the product up for the first time Getting started, guides
Sellers using it day to day Working with the dashboard, troubleshooting
Developers integrating with the API API reference, data model

Building locally

pip install -r requirements.txt
mkdocs serve

The site is served at http://127.0.0.1:8000 and reloads on save.

To reproduce what CI does, including the link and nav checks that fail the build:

mkdocs build --strict

Publishing

Every push to main triggers .github/workflows/deploy.yml, which builds the site with --strict and publishes it to GitHub Pages. A broken internal link fails the build rather than shipping.

Conventions

Style rules, terminology decisions and the review checklist are documented in Documentation standards. Read that page before opening a pull request against docs/.

About

Technical documentation for the Marketplace Analytics platform — API reference, setup guides, release notes. MkDocs Material · docs-as-code · GitHub Actions

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors