Skip to content

General Docs Overhaul#219

Open
S-Haime wants to merge 71 commits into
mainfrom
b-preparation-for-more
Open

General Docs Overhaul#219
S-Haime wants to merge 71 commits into
mainfrom
b-preparation-for-more

Conversation

@S-Haime
Copy link
Copy Markdown
Member

@S-Haime S-Haime commented May 21, 2026

This PR started as a 'scaffolding' PR, intended to provide the structure for updates. Due to how things went, this has turnt into a big update instead. This closes #174

It touches nearly all of the docs, it includes:

  • Clarity edits and updates for roles and permissions. This should make the content usable for users, whilst we wait on some devdocs around roles and permissions.
  • Work on using email templates and variables. It aims to make this part of Janeway more accessible to users and give them a clear idea of what is/isn't possible.
  • There has been a lot of confusion from users around how to edit email templates and how variables work. This piece of work will hopefully help with this. We may need to test it / QA it with someone as it's one of the trickier parts of the manager interface.
  • Slight rewriting of parts of the identifiers documentation, based on some of the gaps identified + user feedback. The DataCite elements still need additional work and documentation.
  • Explanation of what the cache is and why someone may wish to clear it.
  • Carousel configuration guidance. (New page.)
  • Journal management landing page, to help users find the documentation they need. (New page.)
  • Edits around indentation, capitalisation, punctuation and other formatting/copyediting details.
  • A start on repository documentation

S-Haime and others added 30 commits December 15, 2025 15:02
…nagement. Roles and accounts to be done tomorrow - doing this on Google Drive in the first instance for sanity.
…ht I'd share what I've edited so far so it doesn't look like I did nothing when you look at this branch ;) Docs on handling emails and reminders are the main things in this commit. There are a few bits I would still like to do here, but alas never enough time.
Updated copyediting task instructions for clarity and consistency.
Formatted draft decision types for clarity and consistency.
Correct formatting and add missing hyperlinks in the workflow editor typesetting guide.
Updated jhalf the docs, got distracted - will finish at a later point.
@S-Haime S-Haime requested a review from ajrbyers May 21, 2026 09:15
@S-Haime S-Haime added the documentation Improvements or additions to documentation label May 21, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update journal management docs

4 participants