Skip to content

Latest commit

 

History

History
161 lines (138 loc) · 15.1 KB

README.md

File metadata and controls

161 lines (138 loc) · 15.1 KB

docs/

The index to everything written down about Everloot. Start with the data policy and the architecture map.

Guides

File What it is
WORKFLOWS.md Every GitHub Actions workflow: what starts it, what it writes, what a failure means
RELEASING.md Addon (stable and nightly), desktop app and protocol releases, and the pull request title convention
2026-10-08-beta-client-checklist.md What gets checked in the live client before an addon release
2026-10-18-addon-0.3.2-beta-checklist.md, 2026-10-19-addon-0.3.3-beta-checklist.md The in-client checks for the 0.3.2 profession and auction reads and the 0.3.3 completion tracker
2026-10-08-release-checklist.md What gets checked before a site release
OPERATIONS.md How the live site is deployed, warmed, checked and rolled back, what the Worker crons write, and where the other scheduled workflows write
LAUNCH_DAY.md Historical. The launch happened on 2026-11-04: the /beta to Live switch, the build upload, the smoke list, who does each step. Day-to-day operation is OPERATIONS.md
2026-10-28-live-client-capability-checklist.md The current in-game probe list. Prepared on 2026-10-28 and not run, so every row stays unverified until someone runs it in the client
2026-10-28-platform-gap-register.md The long-form backlog: platform gaps in the approved order, and which of them wait on a live check
BUILD_WATCH.md How a new game build becomes a reviewed data pull request
BUILD_REFRESH.md The hand steps after that pull request: tests, perks, art, names, counts, the asset URL, the exports
TRACKER.md The build list, generated from kb/src/bridge-plan.ts (a test keeps it in sync)
ASSETS.md How Blizzard's icons, tooltip text and interface art get onto the site, and the rules for them
SEO.md What the site does so search engines and AI assistants can find and quote it
ENVIRONMENT.md Every variable and secret the project reads, names only, and which surface sets each
../CONTRIBUTING.md, ../ROADMAP.md, ../CHANGELOG.md How to contribute, what is planned, what has shipped

Data policy

File What it is
DATA_POLICY.md What we publish, what we refuse, and why
LEGACY_DATA_POLICY.md How older uploads are handled
OPEN_DATA.md How a maintainer builds the open-data folder (npm run kb -- open-data), uploads it, and what the download page lists. Only facts three installs agree on
LEGACY_PERKS.md One build's Legacy perk trees, read from the game files and kept out of the player-reported data
TALENT_CATALOG.md The talent catalog read from the game files
GUIDES.md The contract every guide meets: review, versions and history, plans, sources

Architecture

File What it is
architecture.md The service and data map
DATA_PLACEMENT.md Where each kind of data is stored, who may write and read it
2026-10-18-database-taxonomy-research.md, 2026-10-18-client-data-placement.md How other game databases map entities, and where each table in the Forever client fits in Everloot
everloot-wow-architecture-audit.md The datamining and community-data audit that led to the game-file layer
2026-10-09-public-mcp-hosting-options.md Where the public MCP endpoint can run
2026-10-09-recipe-capture-options.md, 2026-10-10-recipe-windows-design.md How recipe difficulty is captured
2026-10-17-talent-share-code.md, 2026-10-18-raid-share-code.md The talent and raid share link formats
2026-10-18-mcp-listings.md Listing the MCP server: the registry, the Claude and ChatGPT directories, the words every listing uses

Design specs and plans

design/ holds the notes that sit next to the spec and plan folders. design/specs/ holds the design for each feature, and design/plans/ the plans that built them. Both of those folders are listed by directory and named by date, so the files inside them are not repeated here. Recent specs:

Notes directly under design/:

File What it is
design/2026-11-01-character-showcase-plan.md Plan for public character pages and a share card. The note says it is a plan and contains no code
design/2026-11-01-public-character-policy-draft.md Accepted wording for public character pages. The same section is now in DATA_POLICY.md, and that copy is the one in effect
design/2026-11-02-everloot-score.md The score formula as a library. The note says nothing on the site shows a score
design/2026-11-02-profiles-score-rankings-plan.md Plan for player profiles, the score and a rankings hub. The note says it contains no code
design/2026-11-05-addon-item-decisions-analysis.md Notes from a reel on item decisions and the price tooltip, and a proposed order of work. No runtime change
design/2026-11-05-addon-price-verification.md Check of the price tooltip on one private candidate, keeping addon 0.3.17 and the minimap drawer
design/2026-11-07-profile-pipeline.md How linked characters are digested on a schedule. The first step is behind EVERLOOT_LEADERBOARDS, off by default

Sources

sources/ holds three files, named below. references.md sits beside that folder.

File What it is
sources/LEDGER.md Every external source Everloot has used, linked or read, and how
sources/source-catalog.md The research list of candidate sources and their terms
sources/2026-10-27-class-legacy-dungeon-source-audit.md Whether the sources already allowed can back the class, Legacy and dungeon facts. Read-only; nothing was added to the client tables
references.md Sites whose page shape we learned from, and what we do not take from them

Folders

Folder What it holds
superpowers/plans/ Implementation plans. The Chat workspace plan opens with its goal and the specs it follows; the armory plan opens the same way. Listed by the folder, not file by file
superpowers/specs/ Design notes for Chat dictation, item cards and projects, a sharper Desktop, MCP parity, the sign-in card, and the addon window's gold ledger. Listed by the folder, not file by file
evals/ Question evals and written-answer evals. A question eval counts how names resolved; a written-answer eval scores a reply against an answer key. Listed by the folder, not file by file
fixtures/ Shared test vectors for the talent spend-order token and the plan-link fragment, in talent-order-v1.json
media/ Images the README and the notes embed: the logos, the home, talent, raid, map and changes captures, the Desktop App overview, and three Chat key-card shots

Archive: dated notes

Dated notes at the top of docs/ that are not already named above. The status is what that note says: done, superseded, or still open.

October 2026

Date Note Status
2026-10-21 Everloot 0.3.10: map positions, launch-day check still open: the beta closed before it ran, and no result is recorded
2026-10-21 Connecting a Chat provider by signing in still open: nothing in the note is built
2026-10-21 House cleanup, 2026-10-21 done
2026-10-21 Lane closeout: the addon records vignettes, entrances and encounters done
2026-10-21 Lane closeout: the addon value loop, first slice done
2026-10-21 Coverage engine lane closeout done
2026-10-21 Fact states lane closeout done
2026-10-21 Lane closeout: item numbers players report done
2026-10-21 Launch surfaces lane: closeout done
2026-10-21 Loot tables lane closeout done
2026-10-21 Lane closeout: the map and the instances done
2026-10-21 Lane 5 closeout: the model catalogue behind Chat done
2026-10-21 Lane closeout: the public feed is readable again done
2026-10-22 Coverage MCP tool closeout done
2026-10-22 Coverage score lane closeout done
2026-10-22 Idle cron and internal coverage report closeout done
2026-10-22 Upload index insert closeout done
2026-10-22 Item facts lane closeout done
2026-10-22 Wave 5 lane E: MCP item numbers and settled counts done
2026-10-22 Open data export lane closeout done
2026-10-22 Plateau and spot check lane closeout done
2026-10-22 Recheck cut-off lane closeout done
2026-10-22 Settled list and uploader filter closeout done
2026-10-22 Lane closeout: instance pages in search, the quest filter, the name count done
2026-10-22 Lane C, wave 5: version routing closeout done
2026-10-22 Weapon damage lane closeout done
2026-10-24 Connected planners still open: the in-game layout is unchecked
2026-10-24 Publishing the coverage expected counts done: LAUNCH_DAY.md records the upload for build 70707
2026-10-24 Planner Alpha: live-client verification still open: the note's status is pending
2026-10-25 Chat workspace: migration and activation still open: the apply steps are not marked done
2026-10-27 C05 pilots: review checklist still open: the drafts are not reviewed or published
2026-10-27 Community guide drafts: migration and activation still open: activation is blocked
2026-10-27 Profiles: migration and activation still open: the migration and the switch are not marked on
2026-10-27 Saved builds: activation still open: the migration is in; the switch is not marked on
2026-10-28 Moving the site from Vercel to Cloudflare Workers still open: the note stops at the spike, before the domain switch
2026-10-28 ECON-E01 economy terminology audit still open: F1, F2, F3 and F5 remain
2026-10-28 Desktop and platform readiness handoff still open: several items remain after the source pass
2026-10-30 Social sign-in done
2026-10-31 Addon capture and Home window acceptance still open: not run in game
2026-10-31 Launch acceptance: Desktop 0.1.14 and addon 0.3.15 still open: the cases are left pending

November 2026

Date Note Status
2026-11-02 ChatGPT launch readiness still open: the acceptance table is not passed
2026-11-02 What an Overwolf developer account could do for Everloot done: research only, no account was opened
2026-11-02 Public character pages: decision sheet done; item 7 superseded by one character page
2026-11-02 Public character pages: go-live checklist done, as the private-sync note records
2026-11-02 /privacy: proposed text for linked characters and their public pages superseded by the privacy page
2026-11-03 Catalog kinds: what to check after the merge still open: the after-merge checks have no result recorded
2026-11-03 What the Forever client holds for localized names done
2026-11-06 Private sync and published sections: switch-on steps still open: talent builds are not sent, and the Desktop App release is still named as missing