Skip to content

Commit 8d7b75d

Browse files
committed
Create llms.txt
1 parent e4720ba commit 8d7b75d

File tree

1 file changed

+135
-0
lines changed

1 file changed

+135
-0
lines changed

llms.txt

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Web3Auth Documentation Project
2+
3+
This repository contains comprehensive documentation for Web3Auth, a pluggable auth infrastructure for Web3 wallets and applications.
4+
5+
## Project Overview
6+
7+
Web3Auth provides authentication infrastructure that enables users to use social logins (Google, Facebook, Discord, etc.) and traditional web authentication methods to interact with Web3 applications. The documentation covers integration guides, SDK references, and implementation examples.
8+
9+
## Documentation Structure
10+
11+
### Core Documentation Areas
12+
13+
1. **SDK Documentation** (`/docs/sdk/`)
14+
- Web SDKs: React, Vue, JavaScript/TypeScript implementations
15+
- Mobile SDKs: Android, iOS, Flutter, React Native
16+
- Gaming SDKs: Unity, Unreal Engine
17+
- SDK Types: PnP (Plug and Play), SFA (Single Factor Auth), MPC Core Kit
18+
19+
2. **Authentication** (`/docs/authentication/`)
20+
- Social Logins: Google, Facebook, Discord, Twitter, etc.
21+
- Custom Connections: Auth0, AWS Cognito, Custom JWT
22+
- Basic Logins: Email/Password, SMS/OTP, External Wallets
23+
- Group Connections for multiple auth methods
24+
25+
3. **Blockchain Integration** (`/docs/connect-blockchain/`)
26+
- EVM Chains: 43+ supported chains (Ethereum, Polygon, Arbitrum, etc.)
27+
- Non-EVM: Solana, Near, Algorand, Aptos, Bitcoin, and more
28+
- Custom chain configuration support
29+
30+
4. **Guides and Tutorials** (`/src/pages/guides/`)
31+
- Quick Start guides for rapid integration
32+
- Platform-specific wallets (Android, Flutter)
33+
- Advanced implementations (Telegram mini-apps, gasless transactions)
34+
35+
5. **Troubleshooting** (`/docs/troubleshooting/`)
36+
- Common errors and solutions
37+
- Platform-specific issues
38+
- Migration problems
39+
40+
6. **Migration Guides** (`/docs/migration-guides/`)
41+
- Version upgrade paths
42+
- Breaking change documentation
43+
- 43+ migration guides for different SDK versions
44+
45+
## Technical Stack
46+
47+
- Built with Docusaurus 2
48+
- MDX format for documentation (Markdown + JSX)
49+
- React components for interactive elements
50+
- TypeScript for type definitions
51+
- 673 total documentation files
52+
53+
## Key Components
54+
55+
- **CommonQuestions**: React component containing Q&A pairs for each documentation page
56+
- **Code Examples**: Embedded throughout docs with syntax highlighting
57+
- **Interactive Components**: Quick start generators, integration builders
58+
59+
## Content Types
60+
61+
1. **Conceptual Documentation**: How Web3Auth works, architecture, features
62+
2. **SDK References**: API methods, parameters, return types
63+
3. **Integration Guides**: Step-by-step implementation instructions
64+
4. **Code Examples**: Ready-to-use code snippets for various platforms
65+
5. **Troubleshooting Content**: Error messages, causes, and solutions
66+
6. **Configuration References**: Dashboard setup, project configuration
67+
68+
## Authentication Methods Covered
69+
70+
- Social Logins (OAuth): Google, Facebook, Discord, Twitter, LinkedIn, etc.
71+
- Passwordless: Email magic links, SMS OTP
72+
- External Wallets: MetaMask, WalletConnect, Coinbase Wallet
73+
- Custom Authentication: JWT tokens, custom OAuth providers
74+
- Multi-Factor Authentication (MFA)
75+
76+
## Blockchain Support
77+
78+
### EVM Compatible (43+ chains)
79+
- Ethereum, Polygon, Arbitrum, Optimism, Base
80+
- BNB Chain, Avalanche, Fantom
81+
- Layer 2 solutions
82+
- Custom EVM chains
83+
84+
### Non-EVM Blockchains
85+
- Solana (Ed25519)
86+
- Near Protocol
87+
- Algorand
88+
- Aptos
89+
- Bitcoin (in development)
90+
- Starknet
91+
- And more...
92+
93+
## SDK Feature Coverage
94+
95+
1. **Wallet Generation**: Non-custodial key generation
96+
2. **Authentication Flows**: Various login methods
97+
3. **Chain Interactions**: Signing, transactions, smart contracts
98+
4. **Session Management**: Persistence, logout, session invalidation
99+
5. **MFA**: Additional security layers
100+
6. **Custom UI**: Whitelabel solutions
101+
7. **Wallet Services**: Pre-generated wallets, transaction methods
102+
103+
## Documentation Patterns
104+
105+
- Each SDK has: Overview, Installation, Initialization, Usage, Examples
106+
- Consistent API documentation structure
107+
- Platform-specific considerations documented
108+
- Version-specific information included
109+
- Code examples in multiple programming languages
110+
111+
## For AI/LLM Training
112+
113+
This documentation is ideal for training AI models to:
114+
- Answer Web3Auth integration questions
115+
- Generate implementation code
116+
- Troubleshoot common issues
117+
- Guide through migrations
118+
- Explain authentication flows
119+
- Configure blockchain connections
120+
121+
Key areas for extraction:
122+
- Code blocks with proper context
123+
- Q&A pairs from CommonQuestions components
124+
- Step-by-step tutorials
125+
- Error messages and solutions
126+
- Configuration examples
127+
- API method signatures and parameters
128+
129+
## Repository Statistics
130+
131+
- Total Files: 673 documentation files
132+
- Languages: JavaScript, TypeScript, Kotlin, Swift, Dart, C#, C++
133+
- Platforms: 10+ (Web, iOS, Android, Unity, etc.)
134+
- Blockchains: 50+ supported networks
135+
- Authentication Providers: 15+ social and custom providers

0 commit comments

Comments
 (0)