Skip to content

Improve the documentation - #56

Merged
StroemPhi merged 27 commits into
mainfrom
improve-docs
Feb 25, 2026
Merged

Improve the documentation#56
StroemPhi merged 27 commits into
mainfrom
improve-docs

Conversation

@StroemPhi

Copy link
Copy Markdown
Member

This PR further improves the current documentation to better explain the design principles and pattern of DCAT-AP+ as well as adding documentation on how to use DCAT-AP+ as basis for domain-specific DCAT-AP extensions.

@StroemPhi
StroemPhi marked this pull request as draft February 19, 2026 17:02
@github-actions

github-actions Bot commented Feb 19, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://nfdi-de.github.io/dcat-ap-plus/pr-preview/pr-56/

Built to branch gh-pages at 2026-02-24 19:31 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@StroemPhi
StroemPhi requested a review from dalito February 20, 2026 12:20
@StroemPhi
StroemPhi marked this pull request as ready for review February 20, 2026 12:20
@StroemPhi

Copy link
Copy Markdown
Member Author

@dalito, @HendrikBorgelt and @markdoerr could you please check the docs for errors? They might not be finished yet, but I think they are way better than before and thus a solid foundation for us to present DCAT-AP+ in other contexts in the future like the planned WG Onto presentation. Especially the updated versioning page needs your vetting @dalito.

Thank you

@HendrikBorgelt HendrikBorgelt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation is looking good. I could not even find typos.

Comment thread docs/design-patterns.md Outdated

@dalito dalito left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice overhaul and good additions. I only have minor comments.

In live-preview of the documentation gnerated from this PR, the DCAT-AP+ logo is too small. It should at least double the size (or even more) so that the text can be easily read.

Comment thread docs/automatic-generation.md Outdated
Comment thread docs/how-to-extend.md Outdated
Comment thread docs/how-to-extend.md Outdated
@StroemPhi

Copy link
Copy Markdown
Member Author

Thank you @dalito will fix your suggestions later today.

… part in how-to-extend.md instead of just PROV-O aligned to include the DCTerms alignement
@StroemPhi
StroemPhi requested a review from dalito February 24, 2026 18:54
@StroemPhi

Copy link
Copy Markdown
Member Author

I could make the logo a bit bigger in docs\stylesheets\extra.css. If we want this better, we can tweak it there, causing the header to grow quite big though. Or we use another SVG. This one does not have a transparent background, but I doubt that it would loog good on this blue-greyish header we currently have.

@StroemPhi
StroemPhi merged commit a6d497a into main Feb 25, 2026
7 checks passed
@StroemPhi
StroemPhi deleted the improve-docs branch May 21, 2026 15:12
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.

3 participants