Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Floof NT Company Policy to Guidebook #525

Merged

Conversation

Forzii
Copy link
Contributor

@Forzii Forzii commented Feb 2, 2025

Description

Added Standard Operating Procedures (SOP) root entry to the guidebook, currently with only the company policy from the floof wiki, and added Floof folders to put all the files in. Company policy is default collapsed and contains the entirety of the policy in the root entry, plus broken out in children.

Of note, I experimented with setting priority 1 to ensure the rules were above the policy (when the root was Company Policy), but it seems that priority 0 is the default if none is set - so 1 put the policy at the very bottom. I don't think I like the current position below the standard "space station 14" entry, but it's probably fine? Additionally, the behavior claimed in the comments of GuideEntry.cs of children being placed in the order they are referenced seems to be incorrect, though I'm not sure how much the order matters for the child entries of the policy.

Turns out I'm not the only one who noticed the ordering issues, someone is working on fixing it! space-wizards/space-station-14#34960

This is my first ever PR, so please give feedback!


TODO

  • Add company policy guidebook entries and supporting changes
  • Add SOP root for guidebook and generalize files for future planned additions
  • Get feedback on location in guidebook and the files themselves (I ended up moving everything into Floof folders anyway)
  • Get feedback on if the entirety of the policy should be in the Company Policy root entry or not (no one seems to care)
  • Get feedback on viability of two sources of truth (wiki and guidebook), mitigations, sustainability, etc

Media

image
image
image


Changelog

🆑

  • add: Added NT Company Policy to guidebook

Added company policy from floof wiki to root level of the guidebook, using base game folders.
@github-actions github-actions bot added Status: Needs Review Someone please review this Changes: Documentation Changes any xml or md files Changes: Localization Changes any ftl files Changes: YML Changes any yml files labels Feb 2, 2025
@Forzii Forzii changed the title Initial commit Add Floof NT company policy to guidebook Feb 2, 2025
@Forzii
Copy link
Contributor Author

Forzii commented Feb 2, 2025

So, probably relevant... I want to start adding more of the stuff from the wiki to the guidebook so players don't HAVE to refer to the wiki to get certain information. With that in mind, having "NanoTrasen Company Policy" as a root entry in the guidebook might be somewhat short-sighted. Maybe we should instead nest the company policy under a root entry called "Standard Operating Procedures" like the wiki?

I could also move companypolicy.yml to prototypes->Floof ->Guidebook and the content to ServerInfo->Floof->Guidebook->SOPs or something like that... again, I'd appreciate feedback! I don't really know when we should/shouldn't use Floof folders. Or if you all don't like this at all, lemme know.

EDIT: Switching to a draft for now so I can get feedback, plus I think I want to move things around to make them more modular for future imports from the wiki and stuff.

@Forzii Forzii marked this pull request as draft February 5, 2025 00:02
Changed some file and folder names to be more generic (SOP instead of JUST company policy) in preparation for future additions, plus added an SOP root for the guidebook entries.
I decided that I should probably just move all these server-specific changes into server-specific folders...
@Forzii Forzii marked this pull request as ready for review February 6, 2025 22:25
@FoxxoTrystan FoxxoTrystan added the Priority: 2-Medium Needs to be resolved at some point label Feb 9, 2025
@FoxxoTrystan FoxxoTrystan removed their assignment Feb 10, 2025
Copy link
Collaborator

@FoxxoTrystan FoxxoTrystan left a comment

Choose a reason for hiding this comment

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

Code wise, good but will need to be verified by floof or menmo

@Mnemotechnician
Copy link
Collaborator

This introduces an issue as players will now have two sources of trust: the wiki, which can change any second without any prior notice, and the guidebook, which can only change with a release (or an emergency patch), which typically happens once in a week. I think we need the opinion of wiki/SOP maintainers on this one.

@Forzii
Copy link
Contributor Author

Forzii commented Feb 10, 2025

This introduces an issue as players will now have two sources of trust: the wiki, which can change any second without any prior notice, and the guidebook, which can only change with a release (or an emergency patch), which typically happens once in a week. I think we need the opinion of wiki/SOP maintainers on this one.

Hmm, that's a fair point. It's actually part of why I started with the Company Policy, since it has been a relatively stable document. We could partially mitigate it by assigning the source of truth to the wiki and stating such in the root SOP entry (along with a link to the wiki SOP list page). Could also put a last-modified date at the start of each entry, though that then relies on coders/maintainers updating those dates when changes are made.

A better mitigation would be a workflow or something that automatically pulls and re-formats the pages for the in-game guidebook on a regular basis (weekly?) but I don't foresee anyone doing this (myself included).

Yeah, lets see what the wiki admins think.

Edit/separate notes: Speaking of maintaining this, the fact that I have the entries duplicated is a maintenance headache... I'm going to take another look at that too.
Edit2: Made a commit to get rid of the duplicate information, holding it locally though until I get more feedback from Tech and folks.

@Floof-Station-Bot Floof-Station-Bot changed the title Add Floof NT company policy to guidebook Add Floof NT Company Policy to Guidebook Feb 10, 2025
It occurs to me that duplication is bad for sustainability and could cause problems later!
Attempted to make it clear that the wiki is the source of truth and also added last modified dates.
@Forzii
Copy link
Contributor Author

Forzii commented Feb 12, 2025

Alright, added some red text to try to make it clear that the wiki is still the source of truth and included last-updated dates. Both Seb and Tech seem good with it, feel free to confer with whoever you need to (or let me know who else I should ask for feedback).

Edit: also I added new screenshots

@FoxxoTrystan FoxxoTrystan merged commit 69fb46c into Fansana:master Feb 16, 2025
14 checks passed
@Forzii Forzii deleted the Add-Floof-NT-company-policy-to-guidebook branch February 16, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes: Documentation Changes any xml or md files Changes: Localization Changes any ftl files Changes: YML Changes any yml files Priority: 2-Medium Needs to be resolved at some point Status: Needs Review Someone please review this
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants