Skip to content

Commit 0fb795b

Browse files
author
Paulo Castellano
committed
Rewrite the site as Connect-only docs against the live REST and MCP contract.
1 parent 7f6e2ac commit 0fb795b

198 files changed

Lines changed: 2528 additions & 13936 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎AGENTS.md‎

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,15 @@
1-
> **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project.
2-
> For Mintlify product knowledge (components, configuration, writing standards),
3-
> install the Mintlify skill: `npx skills add https://mintlify.com/docs`
1+
# TryPost Connect Docs
42

5-
# Documentation project instructions
3+
Mintlify documentation for **TryPost Connect** — B2B publishing infrastructure at [connect.trypost.it](https://connect.trypost.it).
64

7-
## About this project
5+
## Product
86

9-
- This is a documentation site built on [Mintlify](https://mintlify.com)
10-
- Pages are MDX files with YAML frontmatter
11-
- Configuration lives in `docs.json`
12-
- Run `mint dev` to preview locally
13-
- Run `mint broken-links` to check links
7+
Connect is not the TryPost scheduler. There is no calendar, no asset library, no self-host, no workspaces. Media is pass-through: `POST /medias/presign` → `PUT` → `media[].url` = `public_url`. Connect accounts via `GET /social-accounts/connect/{platform}?redirect_url=` (`{url,state}`; browser redirect to the client). MCP is `https://connect.trypost.it/mcp` (OAuth, no API keys, no connect tool).
148

15-
## Terminology
9+
Source of truth for the contract is `~/Herd/trypost-connect` (`routes/api.php`, `app/Mcp/Servers/TryPostServer.php`).
1610

17-
{/* Add product-specific terms and preferred usage */}
18-
{/* Example: Use "workspace" not "project", "member" not "user" */}
11+
## Style
1912

20-
## Style preferences
21-
22-
{/* Add any project-specific style rules below */}
23-
24-
- Use active voice and second person ("you")
25-
- Keep sentences concise — one idea per sentence
26-
- Use sentence case for headings
27-
- Bold for UI elements: Click **Settings**
28-
- Code formatting for file names, commands, paths, and code references
29-
30-
## Content boundaries
31-
32-
{/* Define what should and shouldn't be documented */}
33-
{/* Example: Don't document internal admin features */}
13+
- Active voice, second person
14+
- Sentence case headings
15+
- Do not document the old scheduler (signatures, labels, repurposes, assets, self-hosting)

‎CLAUDE.md‎

Lines changed: 24 additions & 288 deletions
Large diffs are not rendered by default.

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,7 @@
1-
> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style.
1+
# Contributing
22

3-
# Contribute to the documentation
3+
This repository is the Mintlify site for **TryPost Connect**.
44

5-
Thank you for your interest in contributing to our documentation! This guide will help you get started.
6-
7-
## How to contribute
8-
9-
### Option 1: Edit directly on GitHub
10-
11-
1. Navigate to the page you want to edit
12-
2. Click the "Edit this file" button (the pencil icon)
13-
3. Make your changes and submit a pull request
14-
15-
### Option 2: Local development
16-
17-
1. Fork and clone this repository
18-
2. Install the Mintlify CLI: `npm i -g mint`
19-
3. Create a branch for your changes
20-
4. Make changes
21-
5. Navigate to the docs directory and run `mint dev`
22-
6. Preview your changes at `http://localhost:3000`
23-
7. Commit your changes and submit a pull request
24-
25-
For more details on local development, see our [development guide](development.mdx).
26-
27-
## Writing guidelines
28-
29-
- **Use active voice**: "Run the command" not "The command should be run"
30-
- **Address the reader directly**: Use "you" instead of "the user"
31-
- **Keep sentences concise**: Aim for one idea per sentence
32-
- **Lead with the goal**: Start instructions with what the user wants to accomplish
33-
- **Use consistent terminology**: Don't alternate between synonyms for the same concept
34-
- **Include examples**: Show, don't just tell
5+
- Work on `main`.
6+
- Match the live contract in `~/Herd/trypost-connect` (`routes/api.php`, MCP server).
7+
- Preview with `mint dev`. Check links with `mint broken-links`.

‎README.md‎

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,28 @@
1-
# TryPost Docs
1+
# TryPost Connect Docs
22

3-
Documentation for [TryPost](https://github.com/trypost-it/trypost) — open source social media scheduling.
3+
Documentation for [TryPost Connect](https://connect.trypost.it) — social publishing infrastructure (REST + MCP). Built with [Mintlify](https://mintlify.com).
44

5-
## Development
5+
This is **not** the old TryPost scheduler docs.
66

7-
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview changes locally:
7+
## Development
88

99
```bash
1010
npm i -g mint
11-
```
12-
13-
Run at the root of the project:
14-
15-
```bash
1611
mint dev
1712
```
1813

1914
Preview at `http://localhost:3000`.
2015

2116
## Publishing
2217

23-
Changes pushed to the `main` branch are deployed automatically via the [Mintlify GitHub app](https://dashboard.mintlify.com/settings/organization/github-app).
18+
Pushes to `main` deploy via the [Mintlify GitHub app](https://dashboard.mintlify.com/settings/organization/github-app).
2419

2520
## Structure
2621

2722
```
28-
├── getting-started/ # Installation, configuration, first steps
29-
├── platforms/ # LinkedIn, X, Facebook, Instagram, TikTok, YouTube, Threads, Pinterest, Bluesky, Mastodon
30-
├── features/ # Scheduling, workspaces, team management
31-
├── self-hosting/ # Requirements, production, Docker
32-
├── contributing.mdx # Contributing guide
33-
└── docs.json # Mintlify configuration
23+
├── getting-started/ # Auth, first publish
24+
├── guides/ # Connect, media, posts, sets, webhooks, MCP, billing
25+
├── platforms/ # Per-network content types and limits
26+
├── api-reference/ # REST endpoints
27+
└── docs.json
3428
```
35-
36-
## Links
37-
38-
- [TryPost](https://github.com/trypost-it/trypost)
39-
- [Issues](https://github.com/trypost-it/trypost/issues)
40-
- [Discussions](https://github.com/trypost-it/trypost/discussions)

‎ai/antigravity.mdx‎

Lines changed: 0 additions & 62 deletions
This file was deleted.

‎ai/chatgpt.mdx‎

Lines changed: 0 additions & 77 deletions
This file was deleted.

‎ai/claude-code.mdx‎

Lines changed: 0 additions & 73 deletions
This file was deleted.

0 commit comments

Comments
 (0)