Skip to content
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,9 @@ jobs:
FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }}
```

## API Reference
## Documentation

See [PLAN.md](./PLAN.md) for the complete API specification.
Full documentation is available at [activadee.github.io/droid-sdk](https://activadee.github.io/droid-sdk/).

## License

Expand Down
48 changes: 23 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,39 @@
# Website
# Droid SDK Documentation

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
This documentation site is built with [Docusaurus](https://docusaurus.io/).

## Installation
## Structure

```bash
yarn
```
docs/
├── content/ # Documentation content (MDX files)
│ ├── introduction.mdx
│ ├── quickstart.mdx
│ ├── installation.mdx
│ ├── api-reference/
│ ├── concepts/
│ └── guides/
├── src/ # Custom React components and CSS
├── static/ # Static assets (images, etc.)
├── docusaurus.config.ts
├── sidebars.ts
└── package.json
```

## Local Development
## Development

```bash
yarn start
cd docs
bun install
bun 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

```bash
yarn build
bun run build
```

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

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
The site is deployed to GitHub Pages at [activadee.github.io/droid-sdk](https://activadee.github.io/droid-sdk/).
205 changes: 0 additions & 205 deletions docs/api-reference/classes/droid.mdx

This file was deleted.

Loading