Skip to content

Commit bfa74fe

Browse files
Merge pull request #72 from PyConAPAC/update-readme
Update readme to reflect current codebase
2 parents 1c3f36d + 713ad81 commit bfa74fe

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,29 @@ Static website for `pycon.asia`, a community-maintained directory of Python conf
1212
## Files
1313

1414
```text
15-
pythonasia-site-next/
16-
├── index.html Page structure and content
17-
├── styles.css Visual design and responsive layout
18-
├── script.js Event data, filtering, search, and mobile navigation
19-
├── assets/ Images used by the static site
20-
└── README.md Project and contribution guide
15+
├── index.html Page structure and content
16+
├── styles.css Visual design and responsive layout
17+
├── script.js Event data, filtering, search, and mobile navigation
18+
├── assets/ Images used by the static site
19+
├── .github/workflows/deploy.yml GitHub Pages deployment workflow
20+
├── CNAME Custom domain configuration
21+
├── LICENSE MIT license
22+
├── docs/ Project reviews and documentation
23+
├── archive/legacy-react-site/ Archived React application
24+
└── README.md Project and contribution guide
2125
```
2226

23-
This is a plain HTML, CSS, and JavaScript site. It does not require a build step or framework.
27+
The active site is a plain HTML, CSS, and JavaScript site at the repository root. It does not require a build step, package manager, or framework. The older React application is retained under `archive/legacy-react-site/` and is not part of the active deployment.
2428

2529
## Preview Locally
2630

2731
From the repository root, run:
2832

2933
```bash
30-
python3 -m http.server 8000 --directory pythonasia-site-next
34+
python3 -m http.server 8000
3135
```
3236

33-
Open [http://localhost:8000](http://localhost:8000) in a browser. A local HTTP server is recommended because it mirrors static hosting behavior more closely than opening `index.html` directly.
37+
Open [http://localhost:8000](http://localhost:8000) in a browser. Run the command from the repository root. A local HTTP server is recommended because it mirrors static hosting behavior more closely than opening `index.html` directly.
3438

3539
## Adding an Event
3640

@@ -82,7 +86,7 @@ Do not edit or crop this artwork. The image contains the official PythonAsia 202
8286

8387
1. Fork the repository on GitHub.
8488
2. Create a focused branch, for example `add-pycon-example-2027`.
85-
3. Make the change in `pythonasia-site-next`.
89+
3. Make changes to the root static-site files: `index.html`, `styles.css`, `script.js`, or `assets/`.
8690
4. Preview the site locally and check desktop and mobile layouts.
8791
5. Confirm all external links point to official destinations.
8892
6. Commit and push the branch.
@@ -92,10 +96,10 @@ Keep pull requests small and avoid unrelated formatting or design changes.
9296

9397
## Maintainer
9498

95-
- @codemickeycode
99+
- [@codemickeycode](https://github.com/codemickeycode)
96100

97101
## Deployment
98102

99-
The repository currently contains an older React application alongside this static site. The root `CNAME` file identifies `pycon.asia` as the custom domain.
103+
GitHub Actions deploys the root static site to the `gh-pages` branch on every push to `main`. The workflow copies `index.html`, `styles.css`, `script.js`, `assets/`, and `CNAME` into the deployment directory. The root `CNAME` file configures `pycon.asia` as the custom domain.
100104

101-
The deployment workflow must be configured to serve the contents of `pythonasia-site-next` at the domain before this version becomes the production site. Until then, the folder can be previewed locally or hosted as a static directory.
105+
The archived React application is not deployed by this workflow.

0 commit comments

Comments
 (0)