Skip to content

Commit 0d3b4f6

Browse files
committed
chore: update readmes
1 parent 6fe1840 commit 0d3b4f6

File tree

2 files changed

+5
-40
lines changed

2 files changed

+5
-40
lines changed

Diff for: CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The repository is structured as follows:
1010

1111
- `api`: The API server which is served via `https://api.docs.page`. This is an express application which handles tasks such as fetching content from GitHub and markdown parsing.
1212
- `og`: A Next.js application which serves the Open Graph images for documentation pages.
13-
- `website`: A Remix application which serves the main `https://docs.page` website, and the documentation rendering for each repository.
13+
- `website`: A Next.js application which serves the main `https://docs.page` website, and the documentation rendering for each repository.
1414
- `packages/cli`: A CLI for running various commands and scripts for initialization, checking etc. Used locally and on CI environments.
1515

1616
## Running docs.page
@@ -21,6 +21,6 @@ Generally, you'll want to interface with the website and api. To run these concu
2121
bun dev
2222
```
2323

24-
This will start the website on `http://localhost:5173` and the api on `http://localhost:8080`.
24+
This will start the website on `http://localhost:3000` and the api on `http://localhost:8080`.
2525

2626
> The API requires a `GITHUB_APP_ID` and `GITHUB_APP_PRIVATE_KEY` to be set in your environment. These are used to authenticate with the GitHub API. You can create a GitHub App in your GitHub account settings.

Diff for: website/README.md

+3-38
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,5 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# docs.page
22

3-
## Getting Started
3+
This is the website for the docs.page project, which hosts both the docs.page website and the documentation for projects.
44

5-
First, run the development server:
6-
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
20-
21-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
22-
23-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
24-
25-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
26-
27-
## Learn More
28-
29-
To learn more about Next.js, take a look at the following resources:
30-
31-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
32-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
33-
34-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
35-
36-
## Deploy on Vercel
37-
38-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
39-
40-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
5+
This project is a managed workspace using Bun - please see the contributing guide for more information and how to get started.

0 commit comments

Comments
 (0)