8000 Fix docs build by shaunak99 · Pull Request #133 · truffle-ai/saiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix docs build #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/api/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -856,4 +856,4 @@ When reporting errors, include:

- **Back to basics?** Review [Authentication](./authentication) and [REST API](./rest-api)
- **Need examples?** Check out [SDKs & Examples](./sdks-examples)
- **Ready to build?** Head to [Building with Saiki](../../building-with-saiki/)
- **Ready to build?** Head to [Building with Saiki](../building-with-saiki/)
4 changes: 2 additions & 2 deletions docs/docs/building-with-saiki/building-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,8 @@ You now have three working applications that demonstrate:
Ready to take it to the next level?

- **Learn advanced patterns**: Check out [Advanced Patterns](./advanced-patterns) for production-ready techniques
- **Add more tools**: Explore [MCP servers](../../configuring-saiki/mcpServers) for additional capabilities
- **Deploy your service**: See the [deployment guide](../deployment) for production hosting
- **Add more tools**: Explore [MCP servers](../configuring-saiki/mcpServers) for additional capabilities
- **Deploy your service**: See the [deployment guide](../user-guide/deployment) for production hosting
- **Join the community**: Share your creations in our [Discord](https://discord.gg/GFzWFAAZcm)

You're well on your way to building amazing AI applications! 🎉
10 changes: 5 additions & 5 deletions docs/docs/building-with-saiki/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ OPENAI_API_KEY=your_key_here
```

:::tip
Don't have an OpenAI key? You can also use [other providers](../../configuring-saiki/llm/providers) like Anthropic, Google, or even local models.
Don't have an OpenAI key? You can also use [other providers](../configuring-saiki/llm/providers) like Anthropic, Google, or even local models.
:::

### Step 3: Run Your First Agent
Expand Down Expand Up @@ -131,9 +131,9 @@ npm install -g ts-node
### Getting Help

If you run into issues:
1. Check the [troubleshooting section](../../configuring-saiki/llm/providers#troubleshooting) in the providers guide
1. Check the [troubleshooting section](../configuring-saiki/llm/providers#troubleshooting) in the providers guide
2. Join our [Discord community](https://discord.gg/GFzWFAAZcm) for help
3. Look at the [examples repository](../../getting-started/examples-demos) for working code
3. Look at the [examples repository](../getting-started/examples-demos) for working code

## What You've Learned

Expand All @@ -148,7 +148,7 @@ In just 5 minutes, you've:
Ready to build something more interesting?

- **Build real applications**: Check out [Building Applications](./building-applications) for practical examples
- **Customize your agent**: Learn about [LLM configuration](../../configuring-saiki/llm/) to change models and behavior
- **Add more tools**: Explore [MCP servers](../../configuring-saiki/mcpServers) to give your agent new capabilities
- **Customize your agent**: Learn about [LLM configuration](../configuring-saiki/llm/) to change models and behavior
- **Add more tools**: Explore [MCP servers](../configuring-saiki/mcpServers) to give your agent new capabilities

The foundation is set - now let's build something amazing! 🚀
2 changes: 1 addition & 1 deletion docs/docs/building-with-saiki/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Resources and guidance for continued learning:
Before you start, make sure you have:

- **Node.js 18+** installed
- **An API key** from one of the [supported LLM providers](../../configuring-saiki/llm/)
- **An API key** from one of the [supported LLM providers](../configuring-saiki/llm/)
- **Basic TypeScript/JavaScript** knowledge
- **A code editor** (VS Code recommended)

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/building-with-saiki/whats-next.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ llm:
apiKey: $GOOGLE_GENERATIVE_AI_API_KEY
```

**Learn more**: [LLM Providers Guide](../../configuring-saiki/llm/providers)
**Learn more**: [LLM Providers Guide](../configuring-saiki/llm/providers)

### 2. Add More Tools
Expand your agents' capabilities with additional MCP servers:
Expand All @@ -51,15 +51,15 @@ mcpServers:
# Add database access, API calls, and more!
```

**Learn more**: [MCP Server Configuration](../../configuring-saiki/mcpServers)
**Learn more**: [MCP Server Configuration](../configuring-saiki/mcpServers)

### 3. Deploy Your Application
Take your application to production:

- **Development** 8000 : Run locally with `npm start`
- **Production**: Use Docker containers with proper monitoring

**Learn more**: [Deployment Guide](../deployment)
**Learn more**: [Deployment Guide](../user-guide/deployment)

## Going Deeper

Expand All @@ -73,16 +73,16 @@ Connect with other developers building AI applications:
### Explore Examples
See what others have built and get inspiration:

- **[Examples Repository](../../getting-started/examples-demos)** - Working code you can run
- **[Examples Repository](../getting-started/examples-demos)** - Working code you can run
- **Community showcase** in our Discord
- **Blog posts** and tutorials from the community

### Read the Advanced Docs
Dive deeper into Saiki's capabilities:

- **[API Reference](../api)** - Complete API documentation
- **[Architecture Overview](../../architecture/overview)** - How Saiki works under the hood
- **[Contributing Guide](../../contribution-guide/overview)** - Help improve Saiki
- **[Architecture Overview](../architecture/overview)** - How Saiki works under the hood
- **[Contributing Guide](../contribution-guide/overview)** - Help improve Saiki

## Pro Tips for Saiki Success

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Saiki is the missing natural language layer across your stack. Its powerful in-b
## Learn More

- **New to AI Agents?** Start with [Basics of AI Agents](../learn/what-is-an-ai-agent.md) to learn the fundamentals
- **Building Applications?** See the [Building with Saiki Guide](../user-guide/development.md) for patterns and examples
- **Building Applications?** See the [Building with Saiki Guide](../building-with-saiki/) for patterns and examples
- **LLM Configuration:** Check out [LLM Providers & Setup Guide](../configuring-saiki/llm/providers) for all supported models
- **Adding Tools:** Learn about [MCP Server Configuration](../configuring-saiki/mcpServers.md) to enhance your agents
- **Core Configuration:** Understand [Configuration](../configuring-saiki/configuration.md) for complete setup
Expand Down Expand Up @@ -104,4 +104,5 @@ saiki "what can you help with?"

---

Saiki is built by the team at Truffle AI. Join our community and help shape the future of natural language automation!
Saiki is built by the team at Truffle AI. Join our community and help shape the future of natural language automation!
2 changes: 1 addition & 1 deletion docs/docs/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Add saiki into an existing typescript project
saiki init-app
```

Check [Application Development Guide](./development.md) for more information!
Check [Building with Saiki Guide](../building-with-saiki/) for more information!

## Coming soon!

Expand Down
0