Skip to main content
GBB

docs-portal

docs: add evaluation walkthrough, architecture and license

Browse files

GBB Demo authored on Nov 2, 2026

parent 64b1040commit 4d9732a83c6c

3 files changed, +89 −1

  • LICENSE+21 −0
    @@ -1,0 +1,21 @@
    1+MIT License
    2+
    3+Copyright (c) 2026 AstraRMM
    4+
    5+Permission is hereby granted, free of charge, to any person obtaining a copy
    6+of this software and associated documentation files (the "Software"), to deal
    7+in the Software without restriction, including without limitation the rights
    8+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    9+copies of the Software, and to permit persons to whom the Software is
    10+furnished to do so, subject to the following conditions:
    11+
    12+The above copyright notice and this permission notice shall be included in all
    13+copies or substantial portions of the Software.
    14+
    15+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    16+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    17+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    18+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    19+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    20+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    21+THE SOFTWARE.
  • README.md+58 −1
    @@ -2,4 +2,61 @@
    22
    33 A static documentation portal with searchable articles and stable URL slugs.
    44
    5−Synthetic evaluation project.
    5+This is an original, synthetic GBB evaluation project. It contains no customer data,
    6+production integrations, live credentials or claimed production history.
    7+
    8+## Start here
    9+
    10+1. Browse `app.mjs` and its tests, then open the commit history.
    11+2. Compare `feature/review-demo` with `main` and review the draft pull request.
    12+3. Pick an open issue, create your own branch, and try a change.
    13+4. Run the checks locally and inspect the resulting diff before merging.
    14+
    15+## Run the checks
    16+
    17+```sh
    18+node test.mjs
    19+```
    20+
    21+Requires Node.js 20 or later; no third-party packages or paid services.
    22+Tests were run during preparation. The platform has no seeded CI results or invented reviews.
    23+
    24+
    25+
    26+## Evaluation ideas
    27+
    28+- Add keyboard navigation to search results.
    29+- Add an edge-case test, inspect blame/history, and discuss the tradeoff in an issue.
    30+- Review the proposed onboarding example in the seeded draft pull request.
    31+
    32+## Repository tour
    33+
    34+- `app.mjs`: working application logic.
    35+- `test.mjs`: executable behavior checks.
    36+- `data/sample.json`: small, synthetic browsing fixture.
    37+- `docs/architecture.md`: design and explicit limitations.
    38+- `feature/review-demo`: a real unmerged change for diff and review exploration.
    39+- `v0.1.0`: annotated baseline tag.
    40+
    41+## Other demo projects
    42+
    43+- [Launchpad Web](../launchpad-web) — A small product launch dashboard with search, filtering and accessible HTML.
    44+- [Taskflow API](../taskflow-api) — A dependency-free task API with validated transitions and a local HTTP server.
    45+- [Pulse Status](../pulse-status) — A service status board that rolls component health into a clear overall status.
    46+- [Ledger Billing](../ledger-billing) — A synthetic invoice calculator using integer cents and explicit discount rules.
    47+- [Feature Flags](../feature-flags) — A deterministic feature flag evaluator with an explicit default and user targeting.
    48+- [Event Router](../event-router) — A small event dispatcher with explicit routing and isolated subscriber failures.
    49+- [Metrics Pipeline](../metrics-pipeline) — A CSV metrics summarizer with nearest-rank percentiles and input validation.
    50+- [Docs Portal](../docs-portal) — A static documentation portal with searchable articles and stable URL slugs.
    51+- [Developer CLI](../developer-cli) — A small command-line project inspector with human-readable and JSON output.
    52+- [Webhook Lab](../webhook-lab) — An HMAC webhook verification example using byte-exact payloads and safe comparison.
    53+
    54+## Scope
    55+
    56+The two investor accounts begin with equivalent source and independent repositories.
    57+These are learning-sized examples, not production services or an assertion that hosted
    58+compute, Actions, billing, email delivery or agent execution has been qualified.
    59+
    60+## License
    61+
    62+MIT. All sample content was created for this evaluation.
  • docs/architecture.md+10 −0
    @@ -1,0 +1,10 @@
    1+# Design
    2+
    3+A static documentation portal with searchable articles and stable URL slugs.
    4+
    5+The core logic is small and deterministic so an evaluator can understand and change it.
    6+Inputs are synthetic, storage is local, and there are no external service calls.
    7+
    8+Next exercise: add keyboard navigation to search results.
    9+
    10+This project deliberately omits production authentication, persistence and deployment.