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: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ Small Dev Talk is an independent news source that covers all things from the ind
11
11
12
12
It is recommended that you use the web-version of Small Dev Talk available at [https://smalldevtalk.net/](https://smalldevtalk.net/) which is an archived version of the original site that is being hosted on [Tumblr](https://smalldevtalk.tumblr.com/). This does require an internet connection to load.
13
13
14
-
If you would like to run this offline, you can download the Github and remove all of <https://raw.githubusercontent.com/AlexJSully/Small-Dev-Talk/master/> from index.js & index.min.js and it would load offline as well.
14
+
For local usage, the app loads metadata from `/src/articleArchive/articleData.json`and article content from `/src/articleArchive/author{AuthorNameNoSpaces}/{YYYY-MM-DD}_{ArticleKey}/{ArticleKey}.md`. You can serve the repository root with `npm run start`and regenerate the service worker with `npm run workbox` after adding assets.
15
15
16
-
To visit specific articles, just change the directory to end with '?' + article name (list of article names can be found in [articleData.json](src\articleArchive\articleData.json)). For example, if you would like to read the Playsets' interview, just change the directory to[https://smalldevtalk.net/index.html?Playsets](https://smalldevtalk.net/index.html?Playsets).
16
+
To visit specific articles, use the first query parameter as the article key from [src/articleArchive/articleData.json](src/articleArchive/articleData.json). For example, [https://smalldevtalk.net/index.html?Playsets](https://smalldevtalk.net/index.html?Playsets).
Copy file name to clipboardExpand all lines: docs/guide/index.md
+8-17Lines changed: 8 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This section contains practical guides for developers working with the Small Dev
4
4
5
5
## Overview
6
6
7
-
The developer guides provide step-by-step instructions for common tasks, from setting up your local environment to publishing new articles and deploying to production. These guides are designed for both internal maintainers and external contributors.
7
+
The developer guides provide step-by-step instructions for common tasks, from setting up a local environment to publishing new articles and running validation scripts.
8
8
9
9
## Available Guides
10
10
@@ -18,9 +18,6 @@ Complete setup guide for local development.
18
18
- Running the local development server
19
19
- Understanding the project structure
20
20
- Configuring development tools (ESLint, Prettier, Markdownlint)
21
-
- Debugging with browser DevTools
22
-
- Working with Service Workers
23
-
- Common troubleshooting steps
24
21
25
22
### [Adding & Publishing Articles](./articles.md)
26
23
@@ -48,22 +45,16 @@ Guide to running tests and ensuring code quality.
48
45
- Code formatting with Prettier
49
46
- Markdown validation
50
47
- Full validation pipeline
51
-
- Debugging test failures
52
48
- Continuous Integration (CI) process
53
49
54
50
### [Deployment & Build](./deployment.md)
55
51
56
-
Build process and deployment to GitHub Pages.
52
+
Deployment and build notes based on repository scripts and workflows.
57
53
58
54
**What you'll learn:**
59
55
60
-
- Building production files (CSS, JS, Service Worker)
61
-
- Understanding the deployment pipeline
62
-
- GitHub Actions workflow
63
-
- Pre-deployment checklist
64
-
- Rollback procedures
65
-
- Environment configuration
66
-
- Performance optimization
56
+
- Service worker generation for precaching
57
+
- Repository deployment notes based on current workflows
Copy file name to clipboardExpand all lines: docs/index.md
+18-21Lines changed: 18 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Small Dev Talk Documentation
2
2
3
-
Welcome to the Small Dev Talk documentation. This directory contains comprehensive guides for understanding, maintaining, and extending the Small Dev Talk codebase.
3
+
Welcome to the Small Dev Talk documentation. This directory contains guides for understanding, maintaining, and extending the Small Dev Talk codebase.
4
4
5
5
## Overview
6
6
7
-
Small Dev Talk is a static web application that archives and displays interviews with indie developers, game developers, and creators across various entertainment industries. The site provides content from multiple authors spanning games, movies, technology, design, and more.
7
+
Small Dev Talk is a static client-side site. On page load, the browser script fetches legacy page definitions and article metadata, then renders either a listing view or a single article based on the URL query string.
8
8
9
9
The project is currently in **maintenance mode**, meaning focus is on bug fixes and security updates rather than new features.
10
10
@@ -32,22 +32,23 @@ Practical guides for developers working with the codebase.
32
32
Detailed documentation for key modules and functions.
33
33
34
34
-[ArticleFiller Class](./api/article-filler.md) — Core class for article loading and page rendering
35
-
-[Sentry Integration](./api/sentry.md) — Error tracking and monitoring configuration
36
-
-[Service Worker](./api/service-worker.md) — Caching strategy and offline support
37
-
-[Build Tools & Scripts](./api/build-tools.md) — Configuration for tooling and automation
0 commit comments