Docs

IP core documentation format

This page explains the structured format used for AccelFury IP core pages, JSON exports, integration notes and verification boundaries.

Open catalog Markdown mirror

Schema

Core data schema

Each public core is represented by typed data and exported as JSON.

Field	Purpose
slug, name, shortDescription	Stable identification and catalog copy.
category, tags, domain	Filtering, discovery and related-core logic.
status, verificationLevel	Evidence-aware maturity and validation state.
license, commercialSupport	Open/commercial use boundary.
repositoryUrl, docsUrl, packageUrl	Public evidence and package links where available.
supportedBoards, supportedToolchains	Target support without implying measured validation.
interfaces, clocks, resets, parameters, ports	Integration contract.
resourceUsage, benchmarks	Measured or explicitly pending evidence.
maturityScore	Optional. Omit unless a public formula and evidence source are documented.
limitations, aiSummary	Do-not-overclaim guidance for humans and LLMs.

type CoreStatus =
  | 'concept'
  | 'planned'
  | 'in_development'
  | 'prototype'
  | 'simulation_tested'
  | 'board_tested'
  | 'production_ready'
  | 'deprecated';

Rules

Integration and verification rules

A core page must say what the core does, what it does not do, target support, gaps and limitations.

Do not infer board support from wrapper presence.
Do not infer production readiness from simulation tests.
Keep code blocks and tables contained on mobile.
Mark resource and benchmark data as pending unless measured.
Link public claims to repository, docs, benchmark or report evidence.

License

Licensing rules

Public code and proprietary use are separate review paths.

Public-source use

Repository license terms apply to public code and must be reviewed per core.

Commercial use

Closed-source, proprietary or customer-delivered bitstream use requires direct licensing discussion where stated.

Support

Paid support depends on integration scope, board target and release criteria.