Semantic overhaul of Scribble with RDFa
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 15/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 領域
- documentation, search
調査の方向性
この issue には、リポジトリのファイル、テスト、エントリーポイントが記載されていません。まず、必要な作業を分解し、実装前にスコープを定義してください。作業には、RDF Turtle/NQuads、JSON-LD、RDFa パース、HDT FFI、OWL オントロジー、Scribble 出力の変更、HDT またはトリプルストアへのクエリが含まれます。完了とは、説明されているセマンティック出力とクエリの全面的な見直しを実施することです。
索引モデルが issue の本文から書いたものです。
説明
This is a proposal for an overhaul of current Scribble implementation.
The goal of the project is for every document generated by Scribble to be semantically annotated with RDFa + JSON-LD and search to be (also) implemented with HDT/SPARQL as engine.
The benefits:
- Flexible Datalog like querying for every facet of document
- Possibility of building Natural Language Querying on top of RDF data and SPARQL- Ease of extending properties thanks to Open World Assumption of OWL.
- Data annotation can be as granular as needed (e.g. it could include source code line on github for every paragraph).
- Semantic annotation is accessible for search engines crawlers.
- If packagsrc would implement semantic data the data integration between these 2 would be seamless (e.g. you could search for all packages that use SomeFunction)
- Ability to reason about documentation (e.g. list documentation that doesn't fulfill certain criteria)
The means/Required work:
- implement RDF toolset in Racket:
- RDF turtle/NQuads
- JSON-LD (implemented by @cwebber)
- RDFa parser
- HDT ffi (for data storage and querying)
- Building OWL ontology for Scribble documentation/code
- Rework of Scribble output to replace current class based annotation with RDFa. If you are not familiar with Semantic annotation take a look at https://schema.org/Article especially scroll to the bottom to the RDFa tab.
- Data querying based on data stored in HDT files for local documentation and possibly triple store (e.g. RDF4J) for the server side documentation. http://www.rdfhdt.org/what-is-hdt/
If you have any questions regarding benefits/implementation details feel free to ask here.
- 主要言語
- Racket
- スター
- 251
- フォーク
- 101
- 平均マージ
- 11日 9時間
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
racket/scribble のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 74/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
racket/scribble の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
cellrishi-code/claude-skills-atlas#165 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
suradet-ps/codeframe#36 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
EchoTools/nevr-runtime#651 ·
メンテナーはふだん 1 日以内に返信
-
connector docs good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
soma-intelligence/open-health-sync#134 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 70/100
godotengine/godot-proposals#15663 ·