Skip to content

Update headline tagline and add AGENTS guide #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leoncheng57 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update headline tagline and add AGENTS guide #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 53 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# AGENTS.md

## Overview

This repository contains a small personal site built with Vite and React.
Source code lives in `src/`.
Production build output is generated into `docs/`.

## Local Development

Install dependencies:

```bash
npm install
```

Start the local dev server:

```bash
npm run dev
```

Run lint:

```bash
npm run lint
```

Create the production build:

```bash
npm run build
```

## Project Structure

- `src/App.tsx`: top-level app composition
- `src/components/headline/`: intro copy and profile section
- `src/components/social/`: social links section
- `src/styles/`: shared global and color styles
- `public/`: static assets copied through Vite
- `docs/`: generated build output for deployment

## Editing Notes

- Make content and component changes in `src/`, not in `docs/`.
- Rebuild with `npm run build` when you need updated deployment artifacts in `docs/`.
- Keep changes small and consistent with the existing simple site structure.

## Deployment Note

Vite is configured to build into `docs/` in `vite.config.ts`.
If this repository is deployed via GitHub Pages, the published site content comes from that generated directory.
2 changes: 1 addition & 1 deletion docs/assets/index-CwoI78sw.js → docs/assets/index-C-nliP-b.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>Leon&#39;s Website</title>
<meta name="description" content="Generated by create next app" />
<link rel="icon" href="/favicon.ico" />
<script type="module" crossorigin src="/assets/index-CwoI78sw.js"></script>
<script type="module" crossorigin src="/assets/index-C-nliP-b.js"></script>
<link rel="stylesheet" crossorigin href="/assets/index-czb794Pg.css">
</head>
<body>
Expand Down
2 changes: 1 addition & 1 deletion src/components/headline/headline.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const Headline: NextPage = () => {
<p className={styles.summary}>
I am a{" "}
<span className={styles.summaryHighlight}>
Software Engineer
Software Engineer / Learner at Heart
</span>
.
</p>
Expand Down