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: update docs and build.sh #2269

Merged
merged 1 commit into from
Dec 15, 2024
Merged

Conversation

nic11
Copy link
Collaborator

@nic11 nic11 commented Dec 13, 2024

Important

Update documentation and build script to clarify instructions and remove outdated dependencies.

  • Documentation Updates:
    • CONTRIBUTING.md: Clarified Python installation instructions for Windows and removed Python 2 requirement for Linux.
    • docs_deploy.md: Fixed typos in section headers.
    • docs_cmake_workflow.md: Fixed minor formatting issue in CMake command.
  • Build Script Changes:
    • build.sh: Removed Python 2 dependency and deprecated --clean option, replacing it with --clean-cpp and --clean-node.

This description was created by Ellipsis for adfd4a5. It will automatically update as commits are pushed.

@Pospelove Pospelove marked this pull request as ready for review December 15, 2024 10:43
@Pospelove Pospelove changed the title update docs and build.sh internal: update docs and build.sh Dec 15, 2024
@Pospelove Pospelove changed the title internal: update docs and build.sh docs: update docs and build.sh Dec 15, 2024
@Pospelove Pospelove merged commit 0a40874 into skyrim-multiplayer:main Dec 15, 2024
12 checks passed
@Pospelove Pospelove deleted the build branch December 15, 2024 10:44
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to adfd4a5 in 10 minutes and 20 seconds

More details
  • Looked at 109 lines of code in 4 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. build.sh:28
  • Draft comment:
    The comment about Python 2 is outdated and should be removed since Python 2 is no longer required.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. build.sh:45
  • Draft comment:
    Consider using [[ ]] for string comparison as it is more robust and prevents potential issues with special characters.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The TODO comment in build.sh suggests reversing the order or using [[ ]]. This is a valid suggestion as [[ ]] is more robust for string comparison in bash scripts.

Workflow ID: wflow_MiCXQtzZ3hwxy05w


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants