diff --git a/.github/workflows/static-checks.yml b/.github/workflows/static-checks.yml new file mode 100644 index 0000000..7edd340 --- /dev/null +++ b/.github/workflows/static-checks.yml @@ -0,0 +1,17 @@ +name: Static checks +on: + pull_request: + push: + branches: [main] +permissions: + contents: read +jobs: + verify: + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 + with: + persist-credentials: false + - name: Validate static page metadata and article anchors + run: python3 -m unittest discover -s tests -v diff --git a/README.md b/README.md index 187f55b..b0dccbb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,46 @@ -# community-blog +# TypeSafeAI Community Notes -A minimal static blog for sharing posts about TypeSafe AI. +> **Unofficial community project — not the official TypeSafe AI blog or team.** Community organization created by VC Moderator [@BunsDev](https://github.com/BunsDev). -## Open locally +A dependency-free static site for introductory community notes about typed decisions, tool interfaces, and developer workflows. The current entries are short introductory notes, not published benchmarks, official product announcements, or claims of production safety. -Open `index.html` in a browser, or serve the repository root with a static file server. \ No newline at end of file +![Community Notes editorial card](docs/discovery/assets/social-preview.svg) + +[Contributing](CONTRIBUTING.md) · [Agent instructions](AGENTS.md) · [Publishing guide](docs/discovery/README.md) · [Machine-readable navigation](llms.txt) + +## Preview locally + +Open `index.html` in a browser, or serve the repository using Python's local static server: + +```sh +python3 -m http.server 8080 --bind 127.0.0.1 +``` + +Visit `http://127.0.0.1:8080`. No package installation, API key, build step, analytics account, or provider call is required. Binding to loopback avoids exposing a development server to other machines. + +## Project map + +- `index.html`: the full static page, styles, article anchors, and metadata. +- `tests/test_site.py`: dependency-free checks for discovery metadata, community identity, and article links. +- `docs/discovery/`: editorial card and publishing/screenshot guidance. +- `repository-metadata.json`: intended GitHub About/topics, not applied settings. + +## Edit and verify + +Keep semantic headings and stable article IDs. Link article headings to their fragments so individual notes can be shared within the page. Add a source, concrete example, and limitations to substantive new claims. Do not invent authors, experiment results, dates, deployments, or vendor endorsement. + +```sh +python3 -m unittest discover -s tests -v +``` + +Also inspect the actual page at desktop and mobile widths, keyboard focus, article anchors, and links. Record the source commit and capture environment for screenshots. The SVG above is editorial artwork, not a screenshot. + +## Deployment and sharing + +This repository does not establish a confirmed production origin. The page has title/description and text-card metadata, but deliberately does not invent a canonical URL, sitemap, or absolute OG image URL. Once a public host is chosen, verify its origin and a publicly accessible raster image before adding those values and updating the relevant tests. See the [publishing guide](docs/discovery/README.md). + +The GitHub About/topics manifest does not itself change repository settings. Do not treat a merged source change as deployed-site evidence. + +## Attribution and reuse + +Keep the unofficial notice, original credits, and any third-party notices. No license is added or changed by this documentation work; public availability alone does not establish permission to reuse unlicensed material. Official product and API resources are [typesafe.ai](https://typesafe.ai) and [docs.typesafe.ai](https://docs.typesafe.ai), separate from this community site. diff --git a/docs/discovery/README.md b/docs/discovery/README.md new file mode 100644 index 0000000..71c3f4d --- /dev/null +++ b/docs/discovery/README.md @@ -0,0 +1,23 @@ +# Community Notes — publishing and evidence + +This is an unofficial community static page, not the official TypeSafe AI blog. Read the [README](../../README.md), [agent instructions](../../AGENTS.md), and [contribution guide](../../CONTRIBUTING.md) before editing. + +## Publishing status + +The site is source HTML with no confirmed production origin in this repository. Keep `og:url`, canonical, sitemap, and absolute `og:image` values unset until a host and a real raster image are chosen and verified. The current text-card metadata is intentional, not a claim that a large image preview has been deployed. Update the regression tests alongside an authorized deployment configuration change. + +The [original SVG card](assets/social-preview.svg) is editable 1280×640 editorial artwork. It is not a product screenshot or an accepted GitHub raster upload by itself. Export and visually inspect a PNG before applying the separate repository Social preview setting. Follow the [shared publishing checklist](https://github.com/TypeSafeAI/.github/blob/main/docs/discovery/SHARING.md). + +## Editorial guidance + +Keep a stable ID and self-link for each article heading. Explain one concrete pattern with primary-source links, synthetic examples, and explicit limitations. A typed result is not proof of correctness or execution authorization. Do not add fabricated experiment results, authors, citations, testimonials, or official endorsement. + +Metadata should describe the visible content. Keep titles and descriptions readable, not stuffed with unrelated trending keywords. Repository topics are capability categories, not release tags or ranking guarantees. + +## Verification and screenshots + +Run `python3 -m unittest discover -s tests -v`. Preview the actual HTML at desktop and narrow widths and inspect keyboard focus, article anchors, and wrapping. No external JavaScript, provider calls, credentials, or package installation is needed. + +For each screenshot record the source commit/blob, viewport, capture method, and whether the page was local, preview, or production. Offline HTML renders are not deployed-site evidence. The initiative's local captures used 1440×1000 and 390×844 viewports and reported no horizontal overflow; use the exact source blob in their supplied provenance rather than treating those captures as future-build evidence. + +Follow the [screenshot protocol](https://github.com/TypeSafeAI/.github/blob/main/docs/discovery/SCREENSHOTS.md). Review pixels for private content before publishing. No license or production host is established by this change. diff --git a/docs/discovery/assets/social-preview.svg b/docs/discovery/assets/social-preview.svg new file mode 100644 index 0000000..1cd4c83 --- /dev/null +++ b/docs/discovery/assets/social-preview.svg @@ -0,0 +1,16 @@ + +TypeSafeAI Community Notes — unofficial TypeSafeAI community +Practical notes. Clear boundaries. Editorial project card, not a product screenshot. + + + +TYPESAFEAI / UNOFFICIAL COMMUNITY +08 / 08 +TypeSafeAI Community Notes +Practical notes. Clear boundaries. +COMMUNITY · BLOG · DOCUMENTATION +01Explain a pattern02Link the evidence03Share the limits + +github.com/TypeSafeAI/community-blog +Community-built. Not official. + \ No newline at end of file diff --git a/index.html b/index.html index f833cab..556521f 100644 --- a/index.html +++ b/index.html @@ -3,7 +3,13 @@ - TypeSafe AI Blog + TypeSafeAI Community Notes — Unofficial + + + + + +