rust-lang / rust-lang/nomicon

[Pre-PR Contribution] Structured Rustonomicon Dataset (JSONL + SQLite) for Intelligent Tooling

Open
#490 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
2.3k
Forks
325
PR merge metrics
No merged PRs in 30d

Description

Hi team,

I wanted to share a side project that may be useful to the Rust ecosystem, especially for documentation tools, learning platforms, or AI-assisted programming environments.

I’ve built a structured, machine-usable version of the Rustonomicon, derived directly from the Markdown source:

What It Includes

nomicon_canon_nodes.jsonl: Line-delimited JSON with canonical IDs, titles, tags, trust levels (safe or hazardous), and SHA-256 content hashes.

nomicon.sqlite3: SQLite version of the same data for fast querying, tooling, and offline analysis.

Fully compliant with the original licensing (MIT OR Apache 2.0).

No modifications to the core content—just structure added to enable automated use.

Intended Use Cases

LSP plugins or rust-analyzer enhancements

Static/dynamic analysis tools (e.g., unsafe call tracing)

Educational tools and intelligent code tutors

Fuzzing and verification harnesses that require canonical unsafe examples

Live Repo

https://github.com/DaveTmire85/nomicon-codex

Right now the files are loose in /src, so I'm moving them to /src/codex for clarity.
If this is useful, I’d be happy to upstream the codex/ directory into this repo, or maintain it separately with your blessing.

Appreciate your work and the community’s time—happy to hear any feedback or suggestions.

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the proposed nomicon_canon_nodes.jsonl and nomicon.sqlite3 artifacts in the linked live repo, then inspect this repository’s /src layout and the proposed /src/codex location. Confirm the licensing and whether upstreaming the codex directory is accepted; completion is an agreed placement and contribution scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, sqlite
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.