mrkeyoor.com_
Tue 15 Sept 20:19 UTC
Webevaluationupdated 15 Sept 2026

docs review

Ink Docs is the source and web application for Ink, Kraken's OP Stack layer 2 network. It gives developers network settings, wallet and faucet instructions, contract deployment guides, and directories of tools for building on Ink.

Verdict

Our Ink Docs build completed in 57 seconds after a 91-second install, but the measured checkout had no test target or Dockerfile, and the current repository declares no license. Use the site and source when you are building on Ink or preparing a focused documentation fix. Start from Nextra for your own docs project, and treat the repository's package pins and CI workflow as more reliable setup evidence than its README.

We ran it

Lab card: what happened when we ran docsScreenshot of docs (docs.inkonchain.com)
Install✓ · 91s1054 packages · 932 MB
Build✓ · 57s
Testsn/ano test script
Repo152 files~1,380 lines of source · 21.6 MB · 2 CI workflows

Answers from our run

Does docs build from source?

Dependencies installed in 91 seconds (1054 packages), and the build succeeded in 57 seconds. We cloned commit 2efd77a into a clean Debian container with 3 CPUs and no project-specific setup.

Does docs have tests you can run?

Not through a standard command: the project exposes no test script or target that our harness could run.

Who should not use docs?

Developers looking for a reusable documentation starter with clear reuse rights: on September 15, 2026, GitHub detected no license, and the repository root had no license file.

What are the alternatives to docs?

Arbitrum Docs, ZKsync Docs, Nextra. Our Ink Docs build completed in 57 seconds after a 91-second install, but the measured checkout had no test target or Dockerfile, and the current repository declares no license.

Setup3/5Build passed, but Docker and runtime instructions are stale
Docs3/5Useful Ink guides sit beside setup drift and unfinished sections
Community4/536,504 stars with 30 issues and 59 pull requests open
Maturity3/5Active production site, but no test target, release, or license

Who it’s for

Solidity developers evaluating Ink mainnet at chain ID 57073 or Sepolia at 763373.
Ink contributors correcting guides, network details, provider lists, or the Next.js interface.
Teams that want to inspect the exact MDX behind the public documentation.
Maintainers comfortable with Next.js, Nextra, pnpm, and a hosted deployment pipeline.

Who it’s NOT for

Developers looking for a reusable documentation starter with clear reuse rights: on September 15, 2026, GitHub detected no license, and the repository root had no license file.
Contributors following the README's Docker path: it says to run docker build -t docs ., while our measured checkout had no Dockerfile.
Maintainers who need the README to match production: it says AWS Amplify deploys the site, but the current workflow deploys previews and main to Vercel.
Teams requiring automated behavior tests: commit 2efd77a had no test script or target, so our sandbox had nothing to run.
Readers who expect every tutorial to be finished and every example present: the homepage labels tutorials WIP, and open issue 669 identifies a promised block-number snippet with no code block.

Setup reality

We measured a successful 91-second install that added 1,054 pnpm packages and used 932 MB on disk. The build succeeded in 57 seconds. There was no test script or target, so tests were skipped. The 21.6 MB checkout contained 152 files and roughly 1,380 lines of source.

The README asks for Node 20.11 or newer, while the current project files pin Node 22.14.0 and pnpm 9.12.3. Local development uses pnpm install and pnpm run dev; the production build uses pnpm run build and then generates a sitemap. No application credentials are needed for that local path.

The documented Docker command cannot work from the measured commit because it had no Dockerfile. Hosting also drifted: the README says AWS Amplify, while the current workflow uses a Vercel token for preview and production deployment. Forked pull requests do not receive preview credentials.

The repository is for Ink developers, while Nextra has its own starter

Ink Docs publishes the official working material for mainnet chain ID 57073 and Ink Sepolia chain ID 763373. Its MDX pages cover adding the networks to a wallet, obtaining test funds, choosing an RPC provider, deploying contracts, checking fees, and finding bridges or explorers. Ink itself is an OP Stack layer 2 in the Superchain, backed by Kraken and aimed at decentralized finance applications.

That makes the repository useful in two direct ways. Developers can read the source behind a guide when rendered text is unclear, and contributors can propose a correction next to the component that displays it. The getting-started page recommends Foundry or Hardhat, links a Remix path, and suggests holding at least 0.01 ETH for standard deployments. Those are Ink-specific instructions, not neutral examples for a new documentation site.

Next 15.5.24 and Nextra 3.3.1 keep content close to code

The application uses Next.js 15.5.24, Nextra 3.3.1, React 18.3.1, and the Pages Router. MDX files live under src/pages, while React components handle copy buttons, network controls, navigation, and page metadata. A contributor edits prose and interface code in one repository, then runs JavaScript linting, MDX linting, formatting, spell checking, and the production build through pnpm scripts.

The Pages Router choice is deliberate according to the README, which says compatibility has held back an App Router move. That is fine for this site. It is less attractive as the base for a new project where you want current Next.js conventions and control over future migrations. Nextra's own repository is the cleaner starting point for that job; Ink's code arrives with chain content, brand assets, custom components, and deployment assumptions attached.

What happened when we ran it

Our sandbox cloned commit 2efd77a into a fresh unprivileged container with 3 CPUs and 8 GB of RAM. The pnpm install succeeded in 91 seconds, adding 1,054 packages and occupying 932 MB. The production build passed in 57 seconds. That is a working build, though the installed tree is substantial beside a 21.6 MB checkout with 152 files and about 1,380 source lines.

There was no test script or target, so we skipped tests rather than turning a missing command into a pass. The scan also found 2 CI workflow files, no Dockerfile, and no tests directory. Build success proves that the documentation application compiled in our stated environment. It does not test wallet switching, copied network values, outbound links, heading anchors, or the instructions inside each code example.

The README's Docker and hosting paths no longer match the repository

The README's first production command is docker build -t docs ., yet commit 2efd77a had no Dockerfile. The current root listing still has none. A new contributor who follows that path reaches a dead end before the application starts. The working local route is pnpm, and the package configuration pins Node 22.14.0 with pnpm 9.12.3 even though the README lists Node 20.11 or newer.

Deployment instructions have drifted too. The README says pull requests and the main branch deploy through AWS Amplify. The current CI file uses Vercel for both, with previews limited to branches inside the repository because forked pull requests cannot access the token. This changed on September 14, 2026, when pull request 670 moved deployment to Vercel. The source now explains production better than the front door does.

Missing license terms make reuse a separate decision

GitHub reports no detected license for the repository, and the root contains no license file. You can read the public source and submit a patch through GitHub. Copying the theme, components, or a large body of text into another product raises a different question because the repository does not state reuse terms. Organizations that need clear permission should get that clarification before treating Ink Docs as a template.

The absence is easy to miss because the project looks like a normal public web repository. It has a lockfile, 2 workflows, lint scripts, and public contribution activity. None of those grants a software license. Nextra has its own upstream repository for teams choosing a docs framework; Ink Docs is best approached as the maintained source for this particular publication.

Thirty open issues point to content and interface gaps

On September 15, 2026, GitHub search returned 30 open issues and 59 open pull requests. Issue 669 identifies an onchain-clients section that promises a block-number example but contains no snippet. Other current proposals address a wallet-network race, duplicate heading IDs, broken edit links, stale explorer entries, and social-image dimensions. These are specific faults readers can encounter, even though our 57-second build stays green.

The homepage also labels its tutorials as WIP. The About page says sub-second blocks are coming, which is an aspiration rather than current behavior. Read chain IDs and RPC addresses from the maintained network page, then verify any operational value before putting funds or production traffic behind it. Documentation for a live chain changes with the chain and its provider list.

September 14 activity outweighs the lack of release tags

The last push was September 14, 2026, when the repository removed a Kraken Verify page. Two other pull requests that day changed hosting and removed old hosting material. GitHub showed 36,504 stars, while the latest-release endpoint returned no published release. For a continuously deployed documentation site, missing release tags do not establish neglect; recent merges and the open queue show active work.

Ink developers should keep the site bookmarked and use the repository when a page needs correction. Maintainers should fix the README before inviting more outside contributions, add behavior checks for the interactive pieces, and declare reuse terms. Until then, the 57-second build is the reassuring part, while the missing test target, Dockerfile, and license are the details that decide how far you should take the code.

Alternatives

ProjectWhat it isPick it when
Arbitrum DocsThe content and web application for Arbitrum's developer documentation.pick this instead when your contracts and infrastructure target Arbitrum rather than Ink.
ZKsync DocsThe developer documentation site for the ZKsync ecosystem.pick this instead when ZKsync's rollup model and tooling match the application you plan to ship.
NextraThe Next.js documentation framework used by the Ink site.pick this instead when you want a reusable docs framework rather than Ink-specific content and branding.

What people are saying

  1. [velocity-scout] inkonchain/docs
  2. [hackernews] Understanding the recent DDoS attack against Read the Docs
  3. [theverge] Google now lets you chat with Gmail, Docs, and Keep

Sources

  1. Ink Docs repository and README
  2. Ink network documentation
  3. Ink development getting started guide
  4. Ink Docs package configuration
  5. Ink Docs CI workflow
  6. Missing block-number example issue 669
  7. Vercel deployment pull request 670

More web reviews

gin · components · docusaurus · react-admin · engine · openui · the whole board →