You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The repository is structured as follows:
10
10
11
11
-`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.
12
12
-`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.
14
14
-`packages/cli`: A CLI for running various commands and scripts for initialization, checking etc. Used locally and on CI environments.
15
15
16
16
## Running docs.page
@@ -21,6 +21,6 @@ Generally, you'll want to interface with the website and api. To run these concu
21
21
bun dev
22
22
```
23
23
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`.
25
25
26
26
> 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.
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
2
2
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.
4
4
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