Skip to content

readme-overhaul#1

Open
LukasOro wants to merge 4 commits into
mainfrom
readme-overhaul
Open

readme-overhaul#1
LukasOro wants to merge 4 commits into
mainfrom
readme-overhaul

Conversation

@LukasOro

Copy link
Copy Markdown

Improvements to over all readability and accessibility for first-time readers and developers that are not already have profound knowledge in semantic web technology

Some open issues have to be discussed before further adaptation of the README.md should take place

Add Problem, How it works, and Inheritance & Composition sections with
collapsible explainers; add comparison table and Project Status & Roadmap;
expand Use Cases (developer-first ordering); add a tool-routing table to
Resources; clarify funding scope to avoid any double-funding impression.

Also ignore docs/ (local reference material + funding application PDF with
sensitive personal data) so it is never published.
…ndancy

Move "Why OO-LD?" to the top as a 4-bullet elevator pitch for fast readers and
de-duplicate it against the deeper sections. Add a Versioning & Identity section
explaining why instances carry only a versioned schema reference (no inline @type).
Remove the duplicated "Standards status" blockquote and the redundant "Start
exploring" footer; clean escaped hyphens; align generated Python field names with
the JSON Schema property casing.
@LukasOro LukasOro requested a review from simontaurus June 19, 2026 11:35
@LukasOro LukasOro self-assigned this Jun 19, 2026
@LukasOro LukasOro added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 19, 2026
@LukasOro

Copy link
Copy Markdown
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants