Metadata Handbook #12
Conversation
WalkthroughA new introductory Quarto markdown file for the "Metadata Handbook" project has been added. This file provides project metadata, author information, resource links, and outlines the handbook’s purpose, intended audience, and current development status, including details about the upcoming Version 2 and its collaborative approach. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
content/projects/metadata-handbook/index.qmd (4)
1-3: Consider adding aslugfor URL consistency
Whiletitleandsubtitleare defined, including aslug: metadata-handbookin the front‐matter can help ensure a stable permalink and simplify cross-linking within your site.
12-22: Review multiplecorresponding: trueflags
All three authors are markedcorresponding: true. Typically only one corresponding author is designated. Either select a primary contact or clarify the intention behind multiple corresponding entries.
31-50: Validate custom link sections and external link behavior
- Ensure your theme supports the custom front-matter keys
other-linksandcode-links.- If you’d like external links to open in a new tab, you can add Quarto attributes (e.g.,
.open new) or usewindowed: truein the link definitions.
55-61: Use Quarto’s native PDF embed instead of raw<iframe>
Leverage Quarto’s built-in::: {pdf} -path: handbuch-diskriminierungsfreie-metadaten.pdf +path: handbuch-diskriminierungsfreie-metadaten.pdf height: 600px title: "Metadata Handbook" :::
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
content/projects/metadata-handbook/handbuch-diskriminierungsfreie-metadaten.pdfis excluded by!**/*.pdf
📒 Files selected for processing (1)
content/projects/metadata-handbook/index.qmd(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build, Optimize, and Upload Artifacts
| ::: {.callout-note title="Work on Version 2 Underway"} | ||
| Since its first publication in June 2024, this handbook has been used and discussed by a growing community of researchers, archivists, and data professionals. Based on the extensive feedback received, a second, significantly expanded and reorganized version is currently in development. | ||
|
|
||
| Levyn Bürki has joined the author team to support this next phase. Their contributions focus on improving inclusive metadata practices, refining data standards, and updating the handbook’s structure to better support practical use in historical research and cultural heritage institutions. | ||
|
|
||
| Version 2 will continue the handbook’s role as an open, living document—publicly available and collaboratively maintained on [GitHub](https://github.com/maehr/diskriminierungsfreie-metadaten)—with the goal of fostering | ||
| ::: |
There was a problem hiding this comment.
Fix truncated sentence in Version 2 callout
The sentence currently ends with “with the goal of fostering” and is incomplete. Please finish the thought to maintain clarity and coherence.
🤖 Prompt for AI Agents
In content/projects/metadata-handbook/index.qmd around lines 63 to 69, the
callout note about Version 2 ends with an incomplete sentence "with the goal of
fostering." Complete this sentence by adding the intended conclusion to clearly
express the goal, ensuring the thought is fully conveyed and the text reads
smoothly.
| author: | ||
| - name: Levyn Bürki | ||
| orcid: 0009-0009-7602-0714 | ||
| email: [email protected] | ||
| affiliation: University of Bern | ||
| roles: | ||
| - writing | ||
| corresponding: true |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Standardize affiliation entries and verify ORCID format
The first author uses a scalar affiliation while the others use lists. For consistency—and to avoid YAML parsing issues—represent all affiliations as lists. Also confirm each ORCID follows the 0000-0000-0000-0000 pattern.
- affiliation: University of Bern
+ affiliation:
+ - University of Bern📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| author: | |
| - name: Levyn Bürki | |
| orcid: 0009-0009-7602-0714 | |
| email: [email protected] | |
| affiliation: University of Bern | |
| roles: | |
| - writing | |
| corresponding: true | |
| author: | |
| - name: Levyn Bürki | |
| orcid: 0009-0009-7602-0714 | |
| email: [email protected] | |
| affiliation: | |
| - University of Bern | |
| roles: | |
| - writing | |
| corresponding: true |
🤖 Prompt for AI Agents
In content/projects/metadata-handbook/index.qmd around lines 4 to 11, the author
metadata uses a scalar value for the affiliation of the first author, while
others use lists. To fix this, change the affiliation field for all authors to
be lists, even if there is only one affiliation. Additionally, verify that each
ORCID follows the standard 0000-0000-0000-0000 format and correct any
deviations.
2 participants
Pull request
Proposed changes
Types of changes
Checklist
Summary by CodeRabbit