Update documentation

[BlackYps]

Description of the proposed changes

Testing done on the proposed changes

Additional context

Checklist

• Changes are annotated, including comments where useful
• Changes are documented in a changelog snippet according to the guidelines.
• Request 2-3 reviewers from the list of reviewers and their areas of knowledge.

Summary by CodeRabbit

• Documentation
  • Migrated changelog and contributor documentation to external hosted pages
  • Updated deployment branch descriptions with clarified branch origins
  • Added information about related database deployments triggered by FAF production deployments
  • Updated documentation links across README files

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2804e54b-496a-499c-a789-8e431067dce3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Three .github/ documentation files (CHANGELOG.md, DEPLOYMENT.md, DEVELOPMENT.md) are emptied. README.md and README-russian.md replace relative .github/ links with URLs pointing to faforever.github.io/fa/. docs/deployment.md rewrites the deploy branch descriptions and adds a "Related deployments" section with unit database workflow links.

Changes

Documentation migration to published site

Layer / File(s)	Summary
README link updates to published docs README.md, README-russian.md	README.md adds a "Changelog" subsection and replaces all relative .github/* links with faforever.github.io/fa/... URLs; README-russian.md updates its single changelog link to the same external URL.
Deployment doc revisions and Related deployments section docs/deployment.md, .github/CHANGELOG.md, .github/DEPLOYMENT.md, .github/DEVELOPMENT.md	Branch bullet descriptions for deploy/faf, deploy/fafbeta, and deploy/fafdevelop are reworded to state all originate from develop; a new "Related deployments" section is added with links to Unit DB, Spooky DB, and ETFreeman DB workflows; the three .github/ doc files are fully emptied.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• FAForever/fa#7084: Both PRs modify changelog-related documentation in .github/DEVELOPMENT.md and changelog generation workflows/templates.

Suggested labels

area: changelog management, area: documentation

Suggested reviewers

• Garanas
• lL1l1

Poem

🐇 Hop, hop — the old docs have gone away,
The .github/ files had nothing left to say.
New links point outward to a published page,
Deploy branches rewritten, clear and sage.
A "Related deployments" section gleams — hooray!
The warren is tidy, updated today! 🌿

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description contains only the template with all sections left blank and no actual content provided about the changes, testing, or context.	Fill in all required sections: describe the documentation changes, explain testing performed, and provide relevant context for why these changes were made.
Title check	❓ Inconclusive	The title 'Update documentation' is vague and generic, failing to specify which documentation or what changes were made despite modifying multiple files.	Replace with a more specific title such as 'Migrate documentation links to external resources' or 'Update documentation structure and references.'

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch update-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)

15-25: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Use descriptive link text instead of "here".

Line 17 uses the generic link text [here], which is flagged by the linter (MD059). Consider using a more descriptive anchor like [complete changelog] or similar.

-You can find the complete changelog [here](https://faforever.github.io/fa/changelog).
+You can find the [complete changelog](https://faforever.github.io/fa/changelog).

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 15 - 25, The link text "here" in the Changelog
section uses generic anchor text which violates the MD059 linting rule and
reduces accessibility. Replace the generic link text "here" with more
descriptive text that clearly indicates what the link points to, such as
"complete changelog", ensuring the new text accurately describes the destination
of the link while maintaining the same URL reference.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/deployment.md`:
- Around line 127-129: The relative file paths in the "Related deployments"
section for the three workflow links (Unit DB, Spooky DB, and ETFreeman DB) are
incorrect and will not resolve properly. Update all three links by replacing the
incorrect `./workflows/` paths with the correct relative path
`../.github/workflows/`. Additionally, fix the double slash syntax error in the
Unit DB link (currently `./workflows//unitdb-update.yaml`) by correcting it to
use the proper path format. This will ensure the links correctly point to the
workflows directory located at `.github/workflows/` from the
`docs/deployment.md` file.

---

Nitpick comments:
In `@README.md`:
- Around line 15-25: The link text "here" in the Changelog section uses generic
anchor text which violates the MD059 linting rule and reduces accessibility.
Replace the generic link text "here" with more descriptive text that clearly
indicates what the link points to, such as "complete changelog", ensuring the
new text accurately describes the destination of the link while maintaining the
same URL reference.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a5a9cad5-e6be-4dcb-903e-557faf8df22c

📥 Commits

Reviewing files that changed from the base of the PR and between c80d63c and a4d8322.

📒 Files selected for processing (6)

• .github/CHANGELOG.md
• .github/DEPLOYMENT.md
• .github/DEVELOPMENT.md
• README-russian.md
• README.md
• docs/deployment.md

💤 Files with no reviewable changes (3)

• .github/DEVELOPMENT.md
• .github/DEPLOYMENT.md
• .github/CHANGELOG.md

[coderabbitai]

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix broken relative file paths in the "Related deployments" section.

The workflow links use incorrect relative paths that will not resolve correctly. The workflows are located at .github/workflows/, not ./workflows/. Additionally, line 127 has a syntax error with a double slash.

From docs/deployment.md, the correct relative path to workflows should be ../.github/workflows/filename. Also, the first link has a double slash (//) which needs to be corrected.

🔗 Proposed fix for the relative paths

-A push to `deploy/faf` will also automatically trigger deployments of the unit databases to keep their info up-to-date:
+A push to `deploy/faf` will also automatically trigger deployments of the unit databases to keep their info up-to-date:
 
-- [Unit DB](./workflows//unitdb-update.yaml)
-- [Spooky DB](./workflows/spookydb-update.yaml)
-- [ETFreeman DB](./workflows/etfreeman-db-update.yaml)
+- [Unit DB](../.github/workflows/unitdb-update.yaml)
+- [Spooky DB](../.github/workflows/spookydb-update.yaml)
+- [ETFreeman DB](../.github/workflows/etfreeman-db-update.yaml)

📝 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.

Suggested change

	- [Unit DB](./workflows//unitdb-update.yaml)
	- [Spooky DB](./workflows/spookydb-update.yaml)
	- [ETFreeman DB](./workflows/etfreeman-db-update.yaml)
	- [Unit DB](../.github/workflows/unitdb-update.yaml)
	- [Spooky DB](../.github/workflows/spookydb-update.yaml)
	- [ETFreeman DB](../.github/workflows/etfreeman-db-update.yaml)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/deployment.md` around lines 127 - 129, The relative file paths in the
"Related deployments" section for the three workflow links (Unit DB, Spooky DB,
and ETFreeman DB) are incorrect and will not resolve properly. Update all three
links by replacing the incorrect `./workflows/` paths with the correct relative
path `../.github/workflows/`. Additionally, fix the double slash syntax error in
the Unit DB link (currently `./workflows//unitdb-update.yaml`) by correcting it
to use the proper path format. This will ensure the links correctly point to the
workflows directory located at `.github/workflows/` from the
`docs/deployment.md` file.