Skip to content

Commit ea18afa

Browse files
dickhardtrohanharikr
dickhardt
and
rohanharikr
authored
Add AI-friendly markdown documentation and MCP integration (#96)
* add MCP placeholder * Add comprehensive MCP server documentation - Complete rewrite of MCP documentation from beta placeholder - Add detailed installation instructions for VS Code and Cursor - Include one-click install links for both editors - Document all available tools and their usage - Add usage examples for common workflows - Include troubleshooting section and security information - Add environment configuration options - Document authentication flow and token management - Include advanced usage for Docker and development - Add links to community resources and contribution guidelines This comprehensive documentation provides developers with everything needed to get started with the Hellō MCP server for application management. * Add AI-friendly markdown documentation and guidance files - Convert HTML documentation to markdown using turndown package - Add automated GitHub workflow for markdown generation - Update MCP server to serve 17 markdown resources instead of 8 HTML - Create comprehensive AI agent guidance files: - robots.txt with AI-specific directives - ai-sitemap.xml for AI crawlers - .well-known/ai.txt following emerging standards - ai-readme.md with complete resource table - /markdown/ index page for human-readable discovery - Automatically update AI sitemap timestamps - All markdown files generated from latest HTML builds - Maintains backward compatibility with existing HTML docs --------- Co-authored-by: rohanharikr <rohanharikumar80@gmail.com>
1 parent 61a1723 commit ea18afa

50 files changed

Lines changed: 15030 additions & 3939 deletions

Some content is hidden

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

‎.github/workflows/generate-markdown.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Generate Markdown Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [ main ]
7+
paths:
8+
- 'pages/docs/**'
9+
- 'scripts/generate-markdown.js'
10+
- '.github/workflows/generate-markdown.yml'
11+
12+
jobs:
13+
generate-markdown:
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write
17+
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: '18'
26+
cache: 'npm'
27+
28+
- name: Install dependencies
29+
run: npm ci
30+
31+
- name: Build site
32+
run: npm run build
33+
34+
- name: Generate markdown from HTML
35+
run: node scripts/generate-markdown.js
36+
37+
- name: Check for changes
38+
id: verify-changed-files
39+
run: |
40+
if [ -n "$(git status --porcelain)" ]; then
41+
echo "changed=true" >> $GITHUB_OUTPUT
42+
echo "Files have changed"
43+
else
44+
echo "changed=false" >> $GITHUB_OUTPUT
45+
echo "No changes detected"
46+
fi
47+
48+
- name: Commit and push changes
49+
if: steps.verify-changed-files.outputs.changed == 'true'
50+
run: |
51+
git config --local user.email "action@github.com"
52+
git config --local user.name "GitHub Action"
53+
git add markdown/
54+
git commit -m "Auto-generate markdown documentation from HTML [skip ci]"
55+
git push

‎markdown/docs/docs.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
DocumentationOverview
2+
3+
# Overview
4+
5+
Quick links to documentation sections:
6+
7+
[Quickstarts](/docs/quickstarts/)[Hellō Buttons](/docs/buttons/)[Hellō Scopes](/docs/scopes/)[SDK Reference](/docs/sdks/)[API Reference](/docs/apis/)[OpenIDOpenID Connect](/docs/oidc/)[Comparison](/docs/comparison/)[Roadmap](/docs/roadmap/)
8+
9+
## Introduction[](#introduction)
10+
11+
Hellō simplifies user registration and login for your application — allowing you to provide all the choices your users may want in minutes instead of hours, days or weeks.
12+
13+
To your application, Hellō is an [OpenID Connect (opens in a new tab)](https://openid.net/specs/openid-connect-core-1_0.html) Provider using the same protocol as social login providers such as Apple, Facebook, Google, and Microsoft. Unlike social login providers, Hellō gathers all the information you request about the user. Your users have choice on how they want to authenticate, which profile picture they want to provide you, and which email they want to verify. Hellō also lets you send the user back to Hellō if they want to update or add to their information. No need for you to implement email or phone verification, or image uploads.
14+
15+
Currently, Hellō is ideal for developers building **new**, **greenfield applications** where there is no requirement to integrate with existing user registration and login. In the future, we will have features that provide simple integration points.
16+
17+
Login providers include: Apple, Discord, Facebook, Google, GitHub, GitLab, Tumblr, Twitch, Line, Mastodon, MetaMask, Microsoft, WordPress.com, Yahoo!, WalletConnect. We also support OTP over email, and QR codes for logging into a desktop with your phone. Mobile devices will prompt the user to register a Passkey for a streamlined experience on their return.
18+
19+
Hellō currently supports Arabic `ar`, English `en`, French `fr`, German `de`, Hindi `hi`, Portuguese `pr`, & Spanish `es`. We welcome [translations (opens in a new tab)](https://github.com/hellocoop/wallet-i18n)!
20+
21+
## User Experience[](#user-experience)
22+
23+
1. The user opens your website and sees the Hellō button and clicks on it.
24+
25+
ō   Continue with Hellō
26+
27+
2. The user is redirected to the Hellō authorize page where they choose their preferred provider to log in. Popular social log in providers, email, phone, and web3 wallets are offered. The user completes logging in with their preferred provider.
28+
29+
3. The user is prompted to provide any claims requested by your application that were not gathered by the provider they chose.
30+
31+
4. The user is shown which claims will be released to your app. They can choose to add other claims to be release. The user clicks continue to release the claims to your app.
32+
33+
5. The user is redirected to your app and is now logged in and your app shows the profile information received from Hellō.
34+
35+
36+
If the user wants to update their profile, they can click an Update button for the data they would like to change, which will take them back to Hellō where they can change the claim to be release to your app, such as a new profile picture or verified email.
37+
38+
ō   Update Email with Hellō
39+
40+
You can check out the Hellō user experience with our demo at [GreenfieldDemo.com (opens in a new tab)](https://greenfielddemo.com) or our [Next.js Starter (opens in a new tab)](https://hello-nextjs-sample.vercel.app/).
41+
42+
## Data Flow[](#data-flow)
43+
44+
1. Your app redirects the user's browser to Hellō (`https://wallet.hello.coop/authorize`) with your request.
45+
46+
2. Hellō requests and receives authentication claims from the user's selected provider.
47+
48+
3. The user provides Hellō any additional claims requested by your app.
49+
50+
4. The user directs Hellō which claims to release to your app.
51+
52+
5. Hellō redirects the user's browser back to your app with either:
53+
54+
55+
- an authorization code, which your app exchanges for an ID Token at the token endpoint
56+
57+
- an ID Token containing the claims the user has chosen to release to your app, and your app verifies the ID Token is valid
58+
59+
60+
This is a standard OpenID Connect data flow. Details in [OpenID Connect](/docs/oidc/).
61+
62+
[Getting Started](/docs/getting-started/ "Getting Started")

‎markdown/docs/docs/apis.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
DocumentationAPI References
2+
3+
# API References
4+
5+
The [Web Client API](/docs/apis/web-client/) is exposed by the [Express](/docs/sdks/express/), [Fastify](/docs/sdks/fastify/), and [Next.js](/docs/sdks/nextjs/) SDKs and provides a simple interface when integrating Hellō into your application.
6+
7+
The [Wallet API](/docs/apis/wallet/) follows the [OpenID Connect](/docs/oidc/) standard. Extensions are documented [here](/docs/apis/wallet/).
8+
9+
The [Quickstart API](/docs/apis/quickstart/) is the web interface to the Quickstart Web app. See [SDK Reference | Quickstart](/docs/sdks/quickstart/) for the node SDK.
10+
11+
[Web Client](/docs/apis/web-client/)[Wallet](/docs/apis/wallet/)[Invite (BETA)](/docs/apis/invite/)[Quickstart](/docs/apis/quickstart/)[Admin](/docs/apis/admin/)
12+
13+
[FAQs](/docs/sdks/faqs/ "FAQs")[Web Client](/docs/apis/web-client/ "Web Client")

‎markdown/docs/docs/apis/admin.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Documentation[API References](/docs/apis/)Admin
2+
3+
# Admin API
4+
5+
The control plane APIs used by the [Hellō Developer Console (opens in a new tab)](https://console.hello.coop) and [Hellō Quickstart (opens in a new tab)](https://quickstart.hello.coop) are an OAuth 2.0 protected resource. If you are interested in integrating Hellō application management into your console, please email us at [contact@hello.coop](mailto:contact@hello.coop?subject=Hell%C5%8D+Controle-Plane+Inquiry)
6+
7+
[Quickstart](/docs/apis/quickstart/ "Quickstart")[OpenID Connect](/docs/oidc/ "OpenID Connect")

0 commit comments

Comments
 (0)