Welcome to your docs project

Project info

URL: https://docs.dev/projects/REPLACE_WITH_PROJECT_ID

Document site template

This repo can be used as a GitHub template for document sites. It includes two patterns; pick one or keep both.

/docs — Documentation-style (product docs, guides, API docs): section nav, read time, tags, markdown/code. Key files: src/pages/Docs.tsx, src/pages/DocDetail.tsx.

/documents — Document-library style (internal docs, reports, archives): category tabs, search, file metadata. Key files: src/pages/Documents.tsx, src/pages/DocumentDetail.tsx.

Steps to choose one: Run locally (npm i && npm run dev) and open /docs and /documents. To keep only one: remove the other’s routes from src/App.tsx, delete its two page files, and remove nav/links. To keep both, replace the sample data in the four page files.

Use as template: Settings → General → check Template repository. Then others can Use this template.

GitHub Pages: Settings → Pages → Source: GitHub Actions. Pushes to main publish to https://<user>.github.io/<repo>/.

How can I edit this code?

There are several ways of editing your application.

Use docs

Simply visit the docs Project and start prompting.

Changes made via docs will be committed automatically to this repo.

Use your preferred IDE

If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in docs.

The only requirement is having Node.js & npm installed - install with nvm

Follow these steps:

# Step 1: Clone the repository using the project's Git URL.
git clone <YOUR_GIT_URL>

# Step 2: Navigate to the project directory.
cd <YOUR_PROJECT_NAME>

# Step 3: Install the necessary dependencies.
npm i

# Step 4: Start the development server with auto-reloading and an instant preview.
npm run dev

Edit a file directly in GitHub

• Navigate to the desired file(s).
• Click the "Edit" button (pencil icon) at the top right of the file view.
• Make your changes and commit the changes.

Use GitHub Codespaces

• Navigate to the main page of your repository.
• Click on the "Code" button (green button) near the top right.
• Select the "Codespaces" tab.
• Click on "New codespace" to launch a new Codespace environment.
• Edit files directly within the Codespace and commit and push your changes once you're done.

What technologies are used for this project?

This project is built with:

• Vite
• TypeScript
• React
• shadcn-ui
• Tailwind CSS

How can I deploy this project?

Simply open docs and click on Share -> Publish.

Can I connect a custom domain to my docs project?

Yes, you can!

To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.

Read more here: Setting up a custom domain