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

docs: Reduce alarmism about docs being outdated #5989

Merged

Conversation

RobbieNeko
Copy link
Collaborator

Purpose of change (The Why)

This alarmism harms the credibility of the docs unnecessarily and evidently scares off some people from using them.

Describe the solution (The How)

Reduce it to a caution from a warning, and in general is less alarmist about the docs being outdated while acknowledging that some parts of them likely are.

Describe alternatives you've considered

  • Remove it altogether

Testing

I read it with my eyes

Additional context

I know at least one modder was scared off of using them by it.

Checklist

Mandatory

@github-actions github-actions bot added the docs PRs releated to docs page label Jan 26, 2025
Copy link
Contributor

autofix-ci bot commented Jan 26, 2025

Autofix has formatted code style violation in this PR.

I edit commits locally (e.g: git, github desktop) and want to keep autofix
  1. Run git pull. this will merge the automated commit into your local copy of the PR branch.
  2. Continue working.
I do not want the automated commit
  1. Format your code locally, then commit it.
  2. Run git push --force to force push your branch. This will overwrite the automated commit on remote with your local one.
  3. Continue working.

If you don't do this, your following commits will be based on the old commit, and cause MERGE CONFLICT.

@RobbieNeko RobbieNeko requested a review from scarf005 January 26, 2025 22:13
@chaosvolt chaosvolt merged commit c49058c into cataclysmbnteam:main Jan 26, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PRs releated to docs page
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants