Skip to content

General Docs Overhaul, take 2#220

Merged
ajrbyers merged 6 commits into
mainfrom
b-general-docs-overhaul
Jun 19, 2026
Merged

General Docs Overhaul, take 2#220
ajrbyers merged 6 commits into
mainfrom
b-general-docs-overhaul

Conversation

@S-Haime

@S-Haime S-Haime commented Jun 16, 2026

Copy link
Copy Markdown
Member

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 S-Haime requested a review from joemull June 16, 2026 15:34
@S-Haime S-Haime mentioned this pull request Jun 16, 2026
Closed
@joemull joemull changed the title B general docs overhaul General Docs Overhaul, take 2 Jun 16, 2026
@joemull joemull mentioned this pull request Jun 16, 2026
Merged
@joemull joemull changed the base branch from main to b-prettier-markdown June 16, 2026 15:49
@joemull

joemull commented Jun 16, 2026

Copy link
Copy Markdown
Member

Super, thank you @S-Haime.

@ajrbyers let's merge #221 and then I will finish my review of this.

Base automatically changed from b-prettier-markdown to main June 17, 2026 09:18
@S-Haime @joemull
General docs overhaul
f57456d 
Squashed commits, Dec 2025 to May 2026:

Typeity type

Winter 2025 docs sprint

Formatty format

minor edits

Sync-y sync I forgot to commit work to branch before. Work on user management. Roles and accounts to be done tomorrow - doing this on Google Drive in the first instance for sanity.

Sync sync

Happy new year! Email log updates.

updates

email logs

I am still (copy)editing work I have done over the break, but I thought 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.

sync sync

Update workflow-author.md

Fix formatting and capitalization in workflow guide

Refine copyeditor assignment instructions

Updated copyediting task instructions for clarity and consistency.
Enhance formatting of draft decision types

Formatted draft decision types for clarity and consistency.
Update workflow-editor-pandoc.md

Fix formatting and minor text adjustments in review guide

Fix formatting and update hyperlinks in typesetting guide

Correct formatting and add missing hyperlinks in the workflow editor typesetting guide.
Update workflow-editor-review.md

Update workflow-reviewer.md

Update workflow-editor-typesetting.md

Update workflow-editor-review.md

Nav docs update

Updated jhalf the docs, got distracted - will finish at a later point.
Further small edits to journal management

Adds a journal management landing page + carousel documentation

Remove unnecessary bullet points in licence properties

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update triple-anonymous-peer-review.md

Update submission-notifications-placeholder.md

Update review-settings.md

Update review-settings.md

Update submission-settings-placeholder.md

Update review-index-placeholder.md

Update open-peer-review.md

Update open-peer-review.md

Update sharing-review.md

Update submission-settings-placeholder.md

Update submission-settings-placeholder.md

Update submission-settings-placeholder.md

Update submission-settings-placeholder.md

Update submission-index-placeholder.md

Update submission-index-placeholder.md

Update submission-index-placeholder.md

Update submission-index-placeholder.md

Fix formatting and improve clarity in review settings

Fix formatting of review sharing settings

Refactor formatting for clarity in peer review settings

Fix formatting and consistency in submission index

Refactor submission settings placeholders for clarity

Update review settings documentation

chore #174 syntax issues in Submission index

Bringing over changes from b-workflow-images to archive that branch and avoid horrible conflicts.

Repo updates pt. 1

Repo docs updates

More preprint updates

repo updates

More repo docs updates

Missed these.

Rename journal_users.png to journal-users.png

Rename forgotten_password.png to forgotten-password.png

Rename upload-icon (1).png to upload-icon.png

Rename press_all_users.png to press-all-users.png

Rename merge_users.gif to merge-users.gif

Edits across the board

Updates

footer edits

Addressed review comments

chore: Prep files for Prettier run

chore: Run prettier on Markdown files
@joemull joemull force-pushed the b-general-docs-overhaul branch from cd6968c to f57456d Compare June 18, 2026 12:34
@joemull joemull force-pushed the b-general-docs-overhaul branch from 15b03ef to f1e24e0 Compare June 19, 2026 10:21
@joemull joemull force-pushed the b-general-docs-overhaul branch from f1e24e0 to 5e56bd8 Compare June 19, 2026 10:22
joemull
joemull requested changes Jun 19, 2026
View reviewed changes

@joemull joemull left a comment •
edited
Loading

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.

Massive job!

Just a few tiny changes requested, mostly about whether things should be commented out.

I also flagged the metadata file that needs merging, in case you want to do that now.

Please let me know if there are any signs the rebase went wrong. For example, if a file is still there that should have been deleted.

Comment thread content/support/accounts-and-roles/accounts-and-roles-index-placeholder.md Outdated
Comment thread content/support/accounts-and-roles/orcid-login-placeholder.md Outdated
Comment thread content/support/analytics/google-analytics-placeholder.md
Comment thread content/support/accounts-and-roles/activating-accounts.md Outdated
Comment thread content/support/article-management/article-metadata-placeholder.md
<!-- Siobhan: this is the only doc that I could not figure out how to merge when I was doing the big merge in the second week of June. -->

<!-- start version 1 -->

@joemull joemull Jun 19, 2026

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.

Flagging this with a GH comment so it comes up in the requested changes list

@S-Haime S-Haime Jun 19, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'll resolve on a new PR, specifically for this, so it can also be properly reviewed etc and so this monster can go to ground - if thats okay?

Comment thread content/support/article-management/articles-management-placeholder.md
Comment thread content/support/guides/janeway-guides.md
@joemull joemull assigned S-Haime and unassigned joemull Jun 19, 2026
@S-Haime

S-Haime commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

Commented bits out as requested + will look at the metadata section next week, as a seperate PR.

@S-Haime S-Haime requested a review from joemull June 19, 2026 13:16
@S-Haime S-Haime assigned joemull and unassigned S-Haime Jun 19, 2026
@joemull joemull requested a review from ajrbyers June 19, 2026 13:55
@ajrbyers ajrbyers merged commit 51f71c7 into main Jun 19, 2026
2 checks passed
@ajrbyers ajrbyers deleted the b-general-docs-overhaul branch June 19, 2026 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ajrbyers ajrbyers ajrbyers approved these changes
@joemull joemull joemull approved these changes

Assignees

@ajrbyers ajrbyers

@joemull joemull

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update journal management docs

3 participants

@S-Haime @joemull @ajrbyers