From fbfea95de699b91ed96673f8789ee860af704b21 Mon Sep 17 00:00:00 2001 From: Srikanth Patchava Date: Fri, 14 Aug 2026 01:26:47 -0700 Subject: [PATCH] docs(readme): refresh README to standardized house style Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 111 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 65 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 71474e5..6f4fdab 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,78 @@ -# EoS Website +# EmbeddedOS Website (GitHub Pages) + +[![CI](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/ci.yml/badge.svg)](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/ci.yml) +[![CodeQL](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/codeql.yml/badge.svg)](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/codeql.yml) +[![Scorecard](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/scorecard.yml/badge.svg)](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/scorecard.yml) +[![Deploy](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/embeddedos-org/embeddedos-org.github.io/actions/workflows/deploy.yml) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + +The **EmbeddedOS developer portal** โ€” a static site served via GitHub Pages. +This is the public entry point to the EmbeddedOS (EoS) ecosystem: static HTML, +CSS, and vanilla JavaScript, no build step required. Package name: +`embeddedos-website`. + +## Pages + +| File | Page | +|---|---| +| `index.html` | Home / landing | +| `getting-started.html` | Getting started guide | +| `get-involved.html` | Contributing / community | +| `hardware-lab.html` | Hardware lab | +| `books.html` | Books / long-form docs index | +| `flow.html` | Ecosystem flow / overview | +| `kids.html` | Kids / education | +| `404.html` | Not-found page | + +Supporting content: -[![Production Ready](https://img.shields.io/badge/Status-Production%20Ready-success?style=for-the-badge)](https://github.com/embeddedos-org/embeddedos-org.github.io) -[![Build Status](https://img.shields.io/badge/Build-Passing-success?style=for-the-badge)](https://github.com/embeddedos-org/embeddedos-org.github.io/actions) -[![Test Coverage](https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge)](https://github.com/embeddedos-org/embeddedos-org.github.io) -[![GPS API](https://img.shields.io/badge/GPS%20API-Integrated-blue?style=for-the-badge)](https://github.com/embeddedos-org/embeddedos-org.github.io) - -EoS Platform Website. Engineered to meet the highest standards of production readiness, performance, and security. - ---- - -## ๐Ÿš€ World-Class Simulation & Analytics - -### Real-Time Emulation Dashboard -Below is the real-time simulation dashboard generated from our production test suite. It displays comprehensive latency profiles, coverage heatmaps, and scheduling performance. - -![Emulation Dashboard](docs/screenshots/embeddedos-org_github_io_simulation.png) - -### Unified Organization Health Matrix -We continuously benchmark EoS Website against the entire EmbeddedOS ecosystem to ensure flawless interoperability. - -![Overall Dashboard](docs/screenshots/overall_dashboard.png) - ---- - -## ๐ŸŽฌ Product Marketing Video (App Store Proof of Production) - -Experience EoS Website in action! Watch our high-fidelity product demonstration and marketing video: - -> ๐ŸŽฅ **[Watch the EoS Website Product Video](docs/videos/embeddedos-org_github_io_marketing.mp4)** +``` +js/ animations.js, ebot-chat.js, search.js, site-chrome.js +stacks/ Technology stack pages (eai-edge.html, index.html) +eApps/ eApps index + icons +downloads/ Downloads index +docs/ Component docs (ebrowser, ebuild, eai, eos, ...) + book/ +style.css Global styles +sitemap.xml, robots.txt, _headers, favicon.svg, og-image.png +``` ---- +## Develop -## ๐Ÿ› ๏ธ Production-Grade Architecture +Serve the site locally (static file server on port 8080): -- **Domain**: HTML โ€ข CSS โ€ข JavaScript -- **GPS Integration**: Production-grade geolocation and time synchronization APIs integrated. -- **Benchmarks**: Outperforms leading industry standards including **GitHub Pages**. +```bash +npm run serve # npx http-server . -p 8080 -s +``` ---- +Then open http://localhost:8080. -## ๐Ÿงช Comprehensive Test Suite +## Test -This repository features **100% test coverage** across four critical categories: -1. **Unit Tests**: Full functional coverage of core components. -2. **Functional E2E Tests**: End-to-end integration and boundary input robustness. -3. **Performance Benchmarks**: Nanosecond-precision latency profiling. -4. **Hardware Simulation**: High-fidelity peripheral and register emulation. +Tests use [Playwright](https://playwright.dev). The config +(`playwright.config.js`) runs specs from `tests/` across chromium, firefox, +webkit, and a mobile-chrome viewport against `http://localhost:8080` (override +with `BASE_URL`). Start the server (`npm run serve`) in another terminal first. -To run the entire suite locally: ```bash -python run_all_tests.py +npm test # all Playwright specs +npm run test:chromium # chromium only +npm run test:links # link checks +npm run test:seo # SEO checks +npm run test:perf # performance checks +npm run test:a11y # accessibility checks +npm run test:responsive + +npm run check:links # linkinator crawl of the running site +npm run lint:html # html-validate +npm run lighthouse # Lighthouse CI collect +npm run audit # test + check:links ``` ---- +## Deploy + +The site is deployed to GitHub Pages via the `deploy.yml` workflow. Content is +served as-is from the repository root. -## ๐Ÿ“œ License & Compliance +## License -Licensed under the MIT License. Aligned with ISO/IEC 25000 software quality standards. +MIT โ€” see [LICENSE](LICENSE).