Skip to content

Latest commit

 

History

History
188 lines (133 loc) · 4.89 KB

README.md

File metadata and controls

188 lines (133 loc) · 4.89 KB

Rise Documentation

This is the documentation website for Rise - an AI-powered visual low-code builder for React applications.

What's Included

This documentation covers:

  • Introduction & Getting Started: Get up and running with Rise
  • Core Concepts: Understand the manifest, components, properties, and code generation
  • User Guides: Detailed guides for using AI generation, styling, and common patterns
  • Architecture: Deep dives into how Rise works internally
  • API Reference: Complete schema and API documentation
  • Contributing: Guidelines for contributing to Rise

Local Development

Prerequisites

  • Node.js 18.0 or higher
  • npm 9.0 or higher

Installation

npm install

Start Development Server

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build for Production

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Serve Production Build Locally

npm run serve

Test the production build locally before deploying.

Documentation Structure

docs/
├── intro.md                      # Introduction to Rise
├── getting-started.md            # Setup and first project
├── concepts/                     # Core concepts
│   ├── overview.md              # Comprehensive concepts guide
│   └── ...                      # Individual concept docs
├── guides/                       # User guides
│   ├── ai-generation.md         # AI generation guide
│   └── ...                      # Other guides
├── architecture/                 # Architecture documentation
│   ├── overview.md              # System architecture
│   └── ...                      # Component deep dives
├── api/                         # API reference
├── advanced/                    # Advanced topics
├── troubleshooting/             # Troubleshooting guides
├── contributing.md              # Contributing guidelines
├── roadmap.md                   # Project roadmap
└── faq.md                       # Frequently asked questions

Writing Documentation

Style Guide

  • Use clear, concise language
  • Include code examples where relevant
  • Add screenshots for UI features
  • Link to related documentation
  • Keep sections focused and scannable

Formatting

  • Use Markdown for all documentation
  • Follow the existing structure
  • Use proper heading hierarchy (H1 → H2 → H3)
  • Include code fences with language specification

Adding New Pages

  1. Create .md file in appropriate directory
  2. Add frontmatter if needed
  3. Update sidebars.js to include the new page
  4. Link from related pages

Code Examples

Use fenced code blocks with language specification:

// Example React component
function Button({ label }) {
  return <button>{label}</button>;
}

Docusaurus Features

This site uses Docusaurus 3, which supports:

  • MDX: Write JSX in Markdown
  • Versioning: Multiple doc versions (future)
  • Search: Built-in search (with Algolia)
  • Dark Mode: Automatic theme switching
  • Responsive: Mobile-friendly by default

Deployment

GitHub Pages

npm run deploy

This command builds the website and pushes it to the gh-pages branch.

Other Platforms

The build directory can be deployed to:

  • Vercel
  • Netlify
  • AWS S3
  • Any static hosting service

Contributing to Docs

Documentation contributions are always welcome!

Types of Contributions

  • Fix typos and grammar
  • Clarify confusing sections
  • Add examples
  • Improve organization
  • Create tutorials
  • Translate to other languages (future)

Process

  1. Fork the repository
  2. Create a branch: git checkout -b docs/improve-section
  3. Make your changes
  4. Test locally: npm start
  5. Submit a pull request

Guidelines

  • Keep explanations clear and beginner-friendly
  • Use active voice
  • Include practical examples
  • Test all code examples
  • Check for broken links
  • Follow existing formatting

Getting Help

License

This documentation is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with:

Rise: Where AI meets empowerment. Where visual meets code. Where lock-in meets freedom.