Skip to content

docs: improve README and add community files#193

Merged
ddeboer merged 8 commits intomainfrom
community-improvements
Mar 4, 2026
Merged

docs: improve README and add community files#193
ddeboer merged 8 commits intomainfrom
community-improvements

Conversation

@ddeboer
Copy link
Member

@ddeboer ddeboer commented Mar 4, 2026

Summary

  • Add tagline: 'Composable building blocks for the full Linked Data lifecycle'
  • Rewrite intro to emphasise the full lifecycle (discovery → ingestion → transformation → publication)
  • Add standards table, key capabilities list, quick code example, and comparison table (LDE vs TriplyETL vs rdf-connect)
  • Replace flat package checklist with an HTML table using colspan header rows for category grouping (Discovery, Processing, Publication, Monitoring, Infrastructure) with per-package npm version badges and descriptions
  • Add architecture diagram showing real package-level dependency relationships (Mermaid)
  • Add 'Who uses LDE' section and Acknowledgements
  • Add development instructions
  • Add MIT licence file and contributing guide

ddeboer added 5 commits March 4, 2026 10:07
- Remove standalone @lde/pipeline npm badge from the header
- Add a 'Version' column with per-package npm badges to all five
  package tables (Discovery, Processing, Publication, Monitoring,
  Infrastructure)
- Update @lde/fastify-rdf description to mention request body parsing
- Replace detailed paragraph with compact logo and link
- Drop table in favour of a plain inline image + anchor
- Add MIT licence file
- Add contributing guide with development workflow
- Split into separate image and text links with an en-space gap
  so the spacing between logo and name is not underlined
- Replace package tables with list-style layout (badge + description)
- Add category descriptions for each package group
- Switch architecture diagram from horizontal to vertical orientation
- Remove Comunica and Apache Jena from comparison table
@ddeboer ddeboer changed the title docs: improve README and add community files docs: improve README, add community files Mar 4, 2026
- Replace Markdown list and table with a single HTML table using
  colspan header rows for category grouping
- Add three architecture diagram variants (categories only, vertical
  with packages, horizontal with packages) for comparison
- Update diagrams to show real package-level dependency arrows
@ddeboer ddeboer changed the title docs: improve README, add community files docs: improve README and add community files Mar 4, 2026
ddeboer added 2 commits March 4, 2026 11:16
- Add tagline under title
- Rewrite intro to emphasise the full Linked Data lifecycle
- Remove planned YAML capability from key capabilities
- Keep only architecture diagram variant B (vertical with packages),
  move it below the packages table
- Remove list and Markdown table variants, keep HTML table only
@ddeboer ddeboer merged commit 159e7f1 into main Mar 4, 2026
2 checks passed
@ddeboer ddeboer deleted the community-improvements branch March 4, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant