From 54614d36c3e1a96c1ac3f8770fe9becd8f09e34b Mon Sep 17 00:00:00 2001 From: Will Eastcott Date: Mon, 25 Mar 2024 14:31:03 +0000 Subject: [PATCH] Tweaks to landing page --- INDEX.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/INDEX.md b/INDEX.md index 5da45cf..8468be6 100644 --- a/INDEX.md +++ b/INDEX.md @@ -1,32 +1,30 @@ -# PlayCanvas - Welcome to the PlayCanvas API Reference! This documentation provides detailed information about the classes, methods, and modules available in the PlayCanvas suite, including the PlayCanvas Engine, PCUI, Observer, Engine Extras, and the Editor API. Our aim is to empower developers with all the information needed to create stunning 3D applications and games using PlayCanvas. -## Modules +### Modules 📦 This documentation is organized into modules that correspond to different PlayCanvas products. Each section contains detailed descriptions of classes, methods, and their respective usage. -| Module | Description | -|---------------|-------------| -| [Engine](./modules/Engine) | The core engine API that powers PlayCanvas applications, providing support for graphics, physics, and more. | -| [EngineExtras](./modules/EngineExtras) | Additional APIs and tools that extend the base PlayCanvas Engine. | -| [Editor](./modules/Editor) | The API for automating and enhancing the functionality of the PlayCanvas Editor. | -| [Observer](./modules/Observer) | An implementation of the [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern), essential for event handling and data binding in complex applications. | -| [PCUI](./modules/PCUI) | A web front-end framework specifically tailored for creating UIs in browser-based tools. | -| [PCUIGraph](./modules/PCUIGraph) | A PCUI extension providing a component for managing node-based graphs. | +| Module | Description | +| -------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| [Engine](./modules/Engine) | The core engine API that powers PlayCanvas applications, providing support for graphics, physics, and more. | +| [EngineExtras](./modules/EngineExtras) | Additional APIs and tools that extend the base PlayCanvas Engine. | +| [Editor](./modules/Editor) | The API for automating and enhancing the functionality of the PlayCanvas Editor. | +| [Observer](./modules/Observer) | An implementation of the [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern), essential for event handling and data binding in complex applications. | +| [PCUI](./modules/PCUI) | A web front-end framework specifically tailored for creating UIs in browser-based tools. | +| [PCUIGraph](./modules/PCUIGraph) | A PCUI extension providing a component for managing node-based graphs. | -## Getting Started +### Getting Started 🚀 To get started with PlayCanvas, you might want to check out the following resources: - [PlayCanvas Developer Site](https://developer.playcanvas.com/) - [PlayCanvas GitHub Organization page](https://github.com/playcanvas/) -## Contributing +### Contributing 🤝 -We welcome contributions to PlayCanvas, including to this API reference! If you'd like to contribute or report issues, please visit our [GitHub](https://github.com/playcanvas/api-reference). +We welcome contributions to PlayCanvas, including to this API reference! If you'd like to contribute or report issues, please visit the [API Reference GitHub repo](https://github.com/playcanvas/api-reference). -## License +### License 📜 This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).