Skip to content

Commit ff5f969

Browse files
update to docs, including ai category with explanation how to set up Bitbybit with context7. Also added additional OCCT Loft documentation.
1 parent 0c57dd1 commit ff5f969

File tree

8 files changed

+236
-4
lines changed

8 files changed

+236
-4
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Occt",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "OCCT Operations",
7+
"description": "There are quite a few operations that can be performed on OCCT shapes. This section will cover the most common ones, such as extrusions, lofts, and more.",
8+
"slug": "/code/common/occt/operations"
9+
}
10+
}

docs/learn/code/common/occt/operations/simple-loft.md

Lines changed: 63 additions & 0 deletions
Large diffs are not rendered by default.

docs/learn/getting-started/rete/typescript-editor-component.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,7 @@ While visual components cover a vast range of functionalities, there are times w
4747
3. **Prototype and Extend:**
4848
* If you find yourself repeatedly writing the same custom script, it might be a candidate for a new, reusable Rete component. The script editor is a great place to prototype this logic. If the idea proves to be generic and useful, we might even incorporate it as a new official component in a future release.
4949

50-
4. **Debug and Understand:**
51-
* Sometimes, seeing the underlying data or a snippet of code can help you understand why a visual graph isn't behaving as expected. The JSON editor can be useful for inspecting the raw structure of your Rete graph.
52-
53-
5. **Overcome Limitations and Avoid Getting Stuck:**
50+
4. **Overcome Limitations and Avoid Getting Stuck:**
5451
* One of the most powerful aspects of this hybrid approach is that you're rarely truly "stuck." If a visual approach hits a wall, you have an alternative. This flexibility is crucial for more complex projects and continuous development.
5552

5653
## A Pathway for Growth: From Explorer to Developer

docs/learn/tags.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,3 +182,8 @@ licensing:
182182
label: Licensing
183183
permalink: /licensing
184184
description: Licensing refers to the legal permissions and restrictions associated with using, modifying, and distributing software.
185+
186+
ai:
187+
label: AI
188+
permalink: /ai
189+
description: AI refers to artificial intelligence technologies and applications, including machine learning and natural language processing.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Using AI With Bitbybit",
3+
"position": 10,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "Using AI With Bitbybit",
7+
"description": "Bitbybit is relatively large coding and design web platform and AI can help you use it more effectively. In these tutorials we will explore how to use AI to enhance your Bitbybit experience.",
8+
"slug": "/using-ai-with-bitbybit"
9+
}
10+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
sidebar_position: 1
3+
title: Introduction to AI with Bitbybit
4+
sidebar_label: Introduction
5+
description: Learn how to leverage Artificial Intelligence within the Bitbybit platform for enhanced coding and design workflows.
6+
tags: [ai]
7+
---
8+
9+
# Leveraging AI with Bitbybit: Enhancing Your Design and Coding Workflow
10+
11+
Bitbybit is an extensive web platform for parametric coding and design, offering a wide array of tools and functionalities. Given its breadth, Artificial Intelligence (AI) can serve as a powerful co-pilot, helping you navigate its features, accelerate your development process, and unlock new creative possibilities. It's important to note that Bitbybit itself **does not provide proprietary Large Language Models (LLMs)**. Instead, we focus on seamless integration with leading third-party AI services and models, allowing you to leverage the best available technologies.
12+
13+
The landscape of AI technology is in a state of constant and rapid evolution. At Bitbybit, we are committed to integrating the latest and most impactful advancements. This includes exploring and incorporating:
14+
15+
* **Cutting-Edge Models:** Primarily LLMs from various providers that can understand and generate human-like text and code. These assist with tasks ranging from script generation and autocompletion to documentation and conceptual brainstorming. The open-source nature of many Bitbybit components and its extensive documentation also plays a crucial role here, as it provides a rich dataset for these foundation models to learn about Bitbybit's core APIs and functionalities, leading to more accurate and relevant AI assistance. Read more about [Our Approach to Open Source](/learn/open-source-approach).
16+
* **Model Context Protocol (MCPs):** an open standard that standardizes how AI applications, like large language models (LLMs), interact with external data sources and tools. It essentially acts as a "universal translator" allowing AI models to communicate with various systems and services. MCP facilitates seamless integration and context sharing, enabling AI models to access information and take actions beyond simple text generation. [Learn More](https://modelcontextprotocol.io/introduction)
17+
* **Specialized Coding Agents:** AI agents fine-tuned for specific programming languages or tasks, such as generating boilerplate code, debugging, or even suggesting more efficient algorithms for your Bitbybit scripts.
18+
19+
While our "Getting Started" guides and detailed coding documentation provide the foundational knowledge for using Bitbybit, this section focuses specifically on the practical application of AI within the platform. We will explore various ways AI models can be utilized, from simple code completion and generation to more advanced collaborative design processes. We'll also provide guidance on setting up and configuring these AI tools to work with your Bitbybit environment.
20+
21+
**Key Concepts You'll Encounter:**
22+
23+
* **Prompt Engineering:** The art and science of crafting effective inputs (prompts) to guide AI models to produce the desired outputs. This involves being clear, concise, and providing sufficient context.
24+
* **Contextual Awareness:** How AI can leverage the context of your current project, active code files, or design intent within Bitbybit to provide more relevant and useful assistance.
25+
* **Iterative Refinement:** Using AI as a partner in an iterative process. You might generate initial ideas or code snippets with AI and then progressively refine them based on your expertise and specific project requirements.
26+
* **Vibe Coding:** An emerging concept where developers communicate their intent to an AI coding assistant in a more natural, high-level, or even abstract way—expressing the "vibe" or desired outcome rather than precise algorithmic steps. The AI then attempts to translate this "vibe" into functional code. This can speed up prototyping and exploration of ideas.
27+
* **Ethical Considerations:** Understanding the limitations, potential biases, and responsible use of AI models in your creative and technical work. This includes data privacy, intellectual property, and the reliability of AI-generated content.
28+
29+
It is crucial to remember that AI is a field characterized by its incredibly fast pace of innovation. Information, tools, and best practices can become outdated quickly. Therefore, we encourage you to approach these guides with an understanding of this dynamic environment and to check back regularly for updates and new insights. Think of this section as a living document, evolving alongside the AI technologies it describes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Model Context Protocol (MCP)",
3+
"position": 10,
4+
"link": {
5+
"type": "generated-index",
6+
"title": "Model Context Protocol (MCP)",
7+
"description": "Learn about the Model Context Protocol (MCP), a powerful way for integrating AI models with Bitbybit. This protocol allows you to define and manage the context in which AI models operate, enhancing their effectiveness in various applications.",
8+
"slug": "/using-ai-with-bitbybit/mcp"
9+
}
10+
}
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
id: context-7
3+
title: Using Context7 MCP with Bitbybit
4+
sidebar_label: Context7 Integration
5+
description: Learn how to connect your AI coding assistant to up-to-date Bitbybit documentation and examples using Context7 and the Model Context Protocol (MCP).
6+
tags: [ai]
7+
---
8+
9+
# Using Context7 MCP with Bitbybit
10+
11+
We are pleased to announce that Bitbybit documentation and example applications are now available via Context7 MCP servers.
12+
You can explore our [GitHub Monorepo](https://github.com/bitbybit-dev/bitbybit) or [find Bitbybit on Context7](https://context7.com/bitbybit-dev/bitbybit).
13+
14+
---
15+
16+
## What is Context7?
17+
18+
Modern AI coding assistants, such as large language models (LLMs), often rely on outdated or generic information about the libraries you use.
19+
Context7 addresses this by providing up-to-date, version-specific documentation and real code examples directly from the source.
20+
21+
With Context7, you can insert accurate and relevant documentation into tools like Cursor, Claude, GitHub Copilot or other LLMs. This leads to better answers, fewer inaccuracies, and an AI that actually understands your technology stack.
22+
23+
### Why Use Context7?
24+
25+
**Without Context7:**
26+
- Documentation may be outdated due to old training data
27+
- Code examples might not work as expected
28+
- Answers are often generic and not tailored to your version
29+
- Extra time is spent verifying AI-generated responses
30+
- The process can be inefficient and frustrating
31+
32+
**With Context7:**
33+
- Documentation is always current and matches your version
34+
- Code examples are real and sourced directly from the project
35+
- Information is concise and directly relevant to your needs
36+
- Free access is available for personal use
37+
- Easily integrates with your MCP server and development tools
38+
39+
---
40+
41+
## Important
42+
43+
MCP works only in agent mode.
44+
45+
## How to Set Up Context7 with MCP in VS Code
46+
47+
You can connect your AI coding assistant in VS Code to Context7 for the latest Bitbybit documentation and examples.
48+
49+
### 1. Add `mcp.json` to Your Project
50+
51+
Create a `.vscode` folder in your project root (if it doesn’t exist), and add a file named `mcp.json` with the following content:
52+
53+
```json title="connecting locally (seems to work better)"
54+
{
55+
"servers": [
56+
{
57+
"command": "npx",
58+
"args": [
59+
"-y",
60+
"@upstash/context7-mcp@latest"
61+
],
62+
"env": {
63+
"DEFAULT_MINIMUM_TOKENS": "10000"
64+
}
65+
}
66+
]
67+
}
68+
```
69+
70+
```json title="connecting via http"
71+
{
72+
"servers": {
73+
"context7": {
74+
"type": "http",
75+
"url": "https://mcp.context7.com/mcp"
76+
}
77+
}
78+
}
79+
```
80+
81+
### 2. Enable MCP in Your Coding Assistant
82+
83+
- Ensure your coding assistant (such as GitHub Copilot) is configured to use MCP.
84+
- In VS Code, check your settings for an option like `chat.mcp.enabled` and make sure it is enabled.
85+
- If you use an Enterprise edition, your organization may need to enable this feature.
86+
87+
### 3. Benefit from Improved AI Assistance
88+
89+
Once set up, your AI assistant will have access to the latest Bitbybit documentation and examples, resulting in more accurate and helpful suggestions.
90+
91+
---
92+
93+
## Caution
94+
95+
Our docs are not yet complete - thus there might be topics that Context7 may not know about. Making docs cover majority of use cases and features is our current priorty, thus results will only improve. At the end this isn't really about AI, it's about our users having access to better and more convenient information sources.
96+
97+
While Context7 is aware of Bitbybit and can provide helpful information, it is not guaranteed to always give you fully accurate answers even if it would have all the information. The quality of responses still depends on the underlying language model, which may sometimes generate incorrect or misleading information (a phenomenon known as "hallucination").
98+
99+
Also, Context7 primarily loads documentation entries that include code snippets. Since it is a third-party service, we cannot guarantee its performance in every situation or that the server will always be available.
100+
101+
Additionally, the Context7 repository scraping process tries to optimize for token limits, which means that some relevant information might be accidentally omitted. Please keep these limitations in mind when using Context7.
102+
103+
## Additional Notes
104+
105+
- For detailed instructions on setting up MCP with other editors or AI tools, refer to their official documentation.
106+
- MCP is an open standard, so most modern editors and AI providers support it.
107+
108+
By integrating Context7 with MCP, you ensure your AI tools always have the most relevant and up-to-date information about Bitbybit, making your coding experience more efficient and productive.

0 commit comments

Comments
 (0)