Skip to content

Commit 120aeed

Browse files
committed
Add API to FAQ
1 parent 8128c3b commit 120aeed

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

web/public/md/faq.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Compass is a **gift from the community** — built by its members like you who c
66

77
Compass is a **free, open-source platform to help people form deep, meaningful, and lasting connections** — whether platonic, romantic, or collaborative. It’s made possible by contributions from the community, including code, ideas, feedback, and donations. Unlike typical apps, Compass prioritizes **values, interests, and personality over swipes and ads**, giving you full control over who you discover and how you connect.
88

9+
### Why is the platform called Compass?
10+
11+
We chose the name Compass because our goal is to help people orient themselves toward the connections that matter most — not just romantically, but intellectually, socially, and collaboratively. Just as a compass points you toward true north, this platform is designed to guide you toward people who align with your values, interests, and deeper goals, helping you navigate the complexity of human relationships with more clarity and intention. It’s not about endless swiping or superficial matches; it’s about finding direction and meaning in the connections you build.
12+
913
### Who is Compass for?
1014

1115
Anyone who wants more than small talk or casual networking. If you value **depth over quantity** and want relationships grounded in **shared values, trust, and understanding**, Compass is for you.
@@ -20,7 +24,7 @@ Anyone who wants more than small talk or casual networking. If you value **depth
2024

2125
### Is Compass for dating or friendship?
2226

23-
Both. You can specify whether you’re looking for **platonic, romantic, or collaborative connections**.
27+
Both, and others things. You can specify whether you’re looking for **platonic, romantic, or collaborative connections**.
2428

2529
### Who started Compass?
2630

@@ -99,9 +103,16 @@ Compass is fully **open source**, which means anyone can view the code, suggest
99103

100104
Whether it’s fixing a small bug, adding a new feature, improving design, or writing tests, contributions of all sizes are welcome. You can explore the code and instructions on our [GitHub repository](https://github.com/CompassConnections/Compass).
101105

102-
### Why is the platform called Compass?
106+
### Does Compass have an API?
103107

104-
We chose the name Compass because our goal is to help people orient themselves toward the connections that matter most — not just romantically, but intellectually, socially, and collaboratively. Just as a compass points you toward true north, this platform is designed to guide you toward people who align with your values, interests, and deeper goals, helping you navigate the complexity of human relationships with more clarity and intention. It’s not about endless swiping or superficial matches; it’s about finding direction and meaning in the connections you build.
108+
Yes. Compass exposes a **public API** for developers who want to build tools, integrations, or visualizations around the platform. The API is fully **documented via Swagger/OpenAPI**, and follows the same transparency principles as the rest of the project:
109+
110+
* **Open access** to non-sensitive public endpoints
111+
* **Authenticated endpoints** for user-specific or administrative actions
112+
* **Rate-limiting** to protect server stability
113+
* **Versioned** to ensure backward compatibility
114+
115+
You can explore or test the API at [https://api.compassmeet.com](https://api.compassmeet.com). Developers can contribute new endpoints or suggest improvements.
105116

106117
### How can I help?
107118

0 commit comments

Comments
 (0)