Skip to content

Commit 8d72127

Browse files
add: create introductory documentation and update homepage link text
1 parent 97e7195 commit 8d72127

2 files changed

Lines changed: 40 additions & 1 deletion

File tree

docs/intro.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Welcome to Graphical Playground Documentation
2+
3+
Welcome to the official documentation for **Graphical Playground**! This documentation provides comprehensive guides, tutorials, and API references to help you build amazing projects with the Graphical Playground engine.
4+
5+
## Documentation Sections
6+
7+
:::warning
8+
This documentation is currently in active development, and some sections may be incomplete or missing. We are working hard to fill in all the gaps and provide a complete resource for our users. If you have any questions or need assistance, please reach out to our support team or community forums.
9+
:::
10+
11+
### Engine Documentation
12+
13+
Learn about the Graphical Playground engine architecture, programming with C++, and core engine concepts.
14+
15+
[Explore Engine Docs →](./engine/intro.md)
16+
17+
### API Reference
18+
19+
Comprehensive API documentation for all engine classes, functions, and modules.
20+
21+
[Explore API Docs →](./api/intro.md)
22+
23+
## Getting Started
24+
25+
New to Graphical Playground? Here are some recommended starting points:
26+
27+
- **Engine Overview**: Learn about the engine architecture and core concepts
28+
- **C++ Programming Guide**: Best practices for programming with the engine
29+
- **API Reference**: Detailed documentation of all engine APIs
30+
31+
## Resources
32+
33+
- [GitHub Repository](https://github.com/GraphicalPlayground)
34+
- [Blog](/blog) - Latest updates and tutorials
35+
- [Community Support](https://graphical-playground.com/support)
36+
37+
---
38+
39+
**Ready to dive in?** Choose a documentation section above to get started!

src/pages/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function HomepageHeader() {
1919
<p className='hero__subtitle'>{siteConfig.tagline}</p>
2020
<div className={styles.buttons}>
2121
<Link className='button button--secondary button--lg' to='/docs/intro'>
22-
Docusaurus Tutorial - 5min ⏱️
22+
Get Started →
2323
</Link>
2424
</div>
2525
</div>

0 commit comments

Comments
 (0)