Skip to content

Add documentation for DataCite plugin#233

Merged
joemull merged 4 commits into
mainfrom
b-datacite-plugin-docs
Jul 3, 2026
Merged

Add documentation for DataCite plugin#233
joemull merged 4 commits into
mainfrom
b-datacite-plugin-docs

Conversation

@ajrbyers

@ajrbyers ajrbyers commented Jul 1, 2026

Copy link
Copy Markdown
Member

Closes #228

@ajrbyers ajrbyers requested a review from S-Haime July 1, 2026 15:35

@S-Haime S-Haime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Few minor things, mostly formatting - we agreed to use sentence case consistently and update JW when we get to it, rather than have either two different styleguides OR have to update the docs as well when JW updates.

The main thing is that I would recommend flagging the bit about the REST API to non-technical users as 'extra curricular' so to speak.

I like that last tip though, that's a good one

Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md Outdated
Comment thread content/support/plugins/datacite.md
Comment thread content/support/plugins/datacite.md Outdated
ajrbyers added 2 commits July 1, 2026 16:52
- Signpost debug-mode test deposits under an Advanced heading and
  drop REST API jargon from the intro for non-technical readers
- Format DOI states as a bulleted list
- Use sentence case for UI labels throughout
- Move the 'no sections selected' note to the start of the section
@joemull joemull self-requested a review July 3, 2026 15:35
@joemull joemull self-assigned this Jul 3, 2026
@joemull joemull merged commit 1bee337 into main Jul 3, 2026
2 checks passed
@joemull joemull deleted the b-datacite-plugin-docs branch July 3, 2026 15:49
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.

DataCite DOIs documentation

3 participants