Repository navigation
docs(site): add the landing page, user guide and developer guide - #91
Merged
Merged
Conversation
nikunj95
force-pushed
the
fm/akt-docs-site
branch
from
September 26, 2026 06:40
3c5cb7d to
14ef125
Compare
Three plain Markdown pages for the public documentation site: a landing page that indexes every document, an end-user guide for someone running the demos from BrainChip Connect, and a developer guide for someone building on the firmware. Every step is worked out from the firmware and the app on main; what the code cannot settle is left as a visible TBD. The existing developer documents under docs/ stay where they are and are linked from the landing page.
Every page now carries the BrainChip copyright footer, the landing page and guides point at the Developer Hub, the Google Play pre-registration listing and Discord, and the user guide covers only what the firmware on main and the app on main do together: the Live Sensor Data screen and its edge-learning controls are out until their future is decided. The third hardware page is the block diagram.
PR #90 removes scripts/kitware-archive.sh; the page already links Kitware's own repository page.
Units ship with the latest release and the demo model loaded and without a battery; Factory Reset and Power Mode are described as they work today with the real feature to follow; the returning-a-unit paragraph goes and problems go to a GitHub issue first; the board overlay page is unlinked from the site.
…nces pages The five documents the captain picked from the proposed set (D-01, D-02, D-03, D-08, D-09). Each is written from the guides, the changelog, the releases and the NOTICE file, with TBD placeholders where the repository does not settle a fact.
The --dk flag changes the configuration only; without BUILD_DIR both boards share build_docker/, so the DK commands set BUILD_DIR=build_docker_dk explicitly, as AGENTS.md does.
The sticker on the development kit in the bench photo was legible. Only that region is blurred; the rest of the photo is unchanged apart from re-encoding.
A Starlight site under site/ whose pages are generated from docs/ by scripts/sync-docs.mjs on every build, with the look approved on the BrainChip Connect documentation (its stylesheet, fonts, logo files and footer band copied as they are), a sidebar with the guides, the hardware pages when docs/hardware exists, the firmware reference pages and the help pages, and Pagefind search.
Builds site/ with Node 22 and deploys site/dist to GitHub Pages whenever docs/, site/ or the workflow change on main. The deploy job checks out nothing; only it holds the pages and id-token permissions.
The five-wire J-Link hookup, reproduced from the board's SWD connection guide with BrainChip's approval.
The black band keeps the wordmark, search, GitHub link and theme switch; the title heads the sidebar above the navigation, on the phone menu too.
Known answers filled in: the model packages attached to every release, the latest-release link in place of a version number, the Apache 2.0 licence, Discord for help and GitHub issues for bugs, the Security tab for vulnerabilities, what the box holds, and the app's Android and iOS availability. Everything still unknown is reworded or dropped and listed for the captain outside the repository.
nikunj95
force-pushed
the
fm/akt-docs-site
branch
from
September 27, 2026 09:07
39ab9df to
c306495
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds the content of the public documentation site as plain Markdown under
docs/:docs/index.md: the landing page, a table of contents pointing at the user guide, the developer guide, the hardware pages (written separately underdocs/hardware/), the existing firmware reference pages, the downloads, the BrainChip Connect documentation, and BrainChip's Developer Hub and Discord.docs/user-guide.md: for someone with an AkidaTag running BrainChip's firmware: pre-registering for BrainChip Connect, connecting, what the LEDs mean, running the keyword spotting demo, updating the firmware over Bluetooth, loading a model, and troubleshooting.docs/quick-start.md,docs/faq.md,docs/support.md,docs/release-notes.mdanddocs/licences.md: the quick start card, the FAQ, where to ask for help, what each firmware release changed and what each release file is for, and the licence of the firmware and of the code it imports.docs/developer-guide.md: for someone building on this code: environment, build, flashing, console, updates, models, signing and which firmware a board accepts, how the application is put together, adding a demo, the Bluetooth interface, and contributing.Every step is worked out from the firmware on
mainand from BrainChip Connect on itsmain, not taken from existing prose. Nothing on the pages is markedTBD: what the code and BrainChip could not settle is reworded or left out, and screenshots come later. Every page carries the BrainChip copyright footer.site/: the documentation site, a Starlight project whose pages are generated fromdocs/bysite/scripts/sync-docs.mjson every build, with the look approved on the BrainChip Connect documentation (its stylesheet, fonts, logo files and footer band copied as they are), a sidebar with the guides, the hardware pages whendocs/hardware/exists, the firmware reference pages and the help pages, and Pagefind search..github/workflows/pages.yml: builds the site and publishes it to GitHub Pages on every push tomainthat touchesdocs/,site/or the workflow.Why
AkidaTag launches for preorder on September 29 and needs published documentation the team can review. The pages are plain, portable Markdown under
docs/so they read on GitHub as they are; the site undersite/renders them with the platform and look approved for the BrainChip Connect documentation.Things to know
main, keyword spotting. The app's Live Sensor Data screen, with its streaming and edge-learning controls, is left out until its future is decided.docs/setup.md,docs/firmware-update-over-usb.md,docs/ble-model-transfer.mdanddocs/BOARD_OVERLAY_CHANGES.mdare unchanged. No file was moved, merged or removed.docs/BOARD_OVERLAY_CHANGES.mdis no longer linked from the site; the file itself is untouched.docs/setup.mdloses the sentence naming the Kitware apt script, which docs(repo): adopt Apache 2.0 and rewrite the public-facing files #90 removes, and is reformatted with prettier in its own commit.mainwith docs(hardware): add the AkidaTag datasheet, technical specifications and block diagram #92 merged, so the Hardware group (datasheet, technical specifications, block diagram) is in the sidebar and every internal link on the site, anchors included, resolves in the built output.mainthat carries it.