Update the setup instructions for the development environment#7036
Update the setup instructions for the development environment#7036NoryGit wants to merge 4 commits intoFAForever:developfrom
Conversation
📝 WalkthroughWalkthroughReplaced occurrences of Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
setup/setup-russian.md (1)
92-97:⚠️ Potential issue | 🟡 MinorUpdate the debugger examples to use the new init filename.
Similar to the English documentation, the examples in the "Подключение отладчика" (Attaching the debugger) section still reference
init_dev.luainstead of the updatedinit_local_development.lua. This creates an inconsistency that could confuse developers.📝 Proposed fix to update the debugger examples
```bat -ForgedAlliance.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log" +ForgedAlliance.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"На:
-FADeepProbe.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log" +FADeepProbe.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@setup/setup-russian.mdaround lines 92 - 97, Update the debugger examples in
the "Подключение отладчика" section to use the new init filename by replacing
any occurrences of init_dev.lua with init_local_development.lua in the example
command lines (e.g., the ForgedAlliance.exe and FADeepProbe.exe examples), so
both commands read .../init "init_local_development.lua" /EnableDiskWatch
/showlog /log "dev.log".</details> </blockquote></details> <details> <summary>setup/setup-english.md (1)</summary><blockquote> `129-134`: _⚠️ Potential issue_ | _🟡 Minor_ **Update the debugger examples to use the new init filename.** The examples in the "Attaching the debugger" section still reference `init_dev.lua`, which is inconsistent with the updated filename `init_local_development.lua` mentioned earlier in the document. This could confuse developers following the setup instructions. <details> <summary>📝 Proposed fix to update the debugger examples</summary> ```diff ```bat -ForgedAlliance.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log" +ForgedAlliance.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"To:
-FADeepProbe.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log" +FADeepProbe.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@setup/setup-english.mdaround lines 129 - 134, The debugger examples still
reference the old init filename init_dev.lua; update both command examples that
invoke ForgedAlliance.exe and FADeepProbe.exe to use the new init filename
init_local_development.lua instead (replace init_dev.lua with
init_local_development.lua in the two occurrences) so the "Attaching the
debugger" section matches the earlier filename mention.</details> </blockquote></details> </blockquote></details>🤖 Fix all issues with AI agents
Verify each finding against the current code and only fix it if needed. In `@setup/setup-english.md`: - Around line 129-134: The debugger examples still reference the old init filename init_dev.lua; update both command examples that invoke ForgedAlliance.exe and FADeepProbe.exe to use the new init filename init_local_development.lua instead (replace init_dev.lua with init_local_development.lua in the two occurrences) so the "Attaching the debugger" section matches the earlier filename mention. In `@setup/setup-russian.md`: - Around line 92-97: Update the debugger examples in the "Подключение отладчика" section to use the new init filename by replacing any occurrences of init_dev.lua with init_local_development.lua in the example command lines (e.g., the ForgedAlliance.exe and FADeepProbe.exe examples), so both commands read .../init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log".
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/development-start-here/lua-setup.md (1)
35-35:⚠️ Potential issue | 🟡 MinorSame pre-existing prose issue as in
docs/development/setup.mdline 35.The text "file your fork to the the bin folder" is missing "from" and has a doubled "the". The fix is identical to the one proposed in
setup.md.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/development-start-here/lua-setup.md` at line 35, Fix the typo in the sentence at the top of docs/development-start-here/lua-setup.md: change "Copy the `init_local_development.lua` file your fork to the the bin folder." to "Copy the `init_local_development.lua` file from your fork to the bin folder." so it includes the missing "from" and removes the duplicated "the".docs/development/setup.md (1)
35-35:⚠️ Potential issue | 🟡 MinorMinor pre-existing prose issue on an adjacent unchanged line.
Line 35 reads:
"Copy the init_local_development.lua file your fork to the the bin folder."— it is missing the word "from" and has a doubled "the". Since this PR is touching this documentation file it would be a good opportunity to fix it.✏️ Suggested prose fix
-Copy the `init_local_development.lua` file your fork to the the bin folder. +Copy the `init_local_development.lua` file from your fork to the bin folder.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/development/setup.md` at line 35, Fix the minor prose typo in the sentence currently reading "Copy the `init_local_development.lua` file your fork to the the bin folder." by inserting the missing preposition and removing the duplicate "the" so it reads: "Copy the `init_local_development.lua` file from your fork to the bin folder." Update this text in docs/development/setup.md where that sentence appears.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/development-start-here/lua-setup.md`:
- Line 35: Fix the typo in the sentence at the top of
docs/development-start-here/lua-setup.md: change "Copy the
`init_local_development.lua` file your fork to the the bin folder." to "Copy the
`init_local_development.lua` file from your fork to the bin folder." so it
includes the missing "from" and removes the duplicated "the".
In `@docs/development/setup.md`:
- Line 35: Fix the minor prose typo in the sentence currently reading "Copy the
`init_local_development.lua` file your fork to the the bin folder." by inserting
the missing preposition and removing the duplicate "the" so it reads: "Copy the
`init_local_development.lua` file from your fork to the bin folder." Update this
text in docs/development/setup.md where that sentence appears.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/development/setup.md (1)
67-67: Consider quotinginit_local_development.luafor consistency.The Windows example (line 48) passes the init file as
"init_local_development.lua", and the/logargument on this very same Linux line is also quoted ("dev.log"). Leaving the init filename unquoted is inconsistent within the example.✏️ Suggested tweak
-$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_local_development.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie +$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init "init_local_development.lua" /showlog /log "dev.log" /EnableDiskWatch /nomovie🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/development/setup.md` at line 67, The command example starting with $RunProton has the init file unquoted (/init init_local_development.lua) which is inconsistent with the Windows example and the quoted /log "dev.log"; change the init argument to use quotes (/init "init_local_development.lua") so the line reads consistently (reference the command beginning with $RunProton and the arguments /init and /log).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/development/setup.md`:
- Line 67: The command example starting with $RunProton has the init file
unquoted (/init init_local_development.lua) which is inconsistent with the
Windows example and the quoted /log "dev.log"; change the init argument to use
quotes (/init "init_local_development.lua") so the line reads consistently
(reference the command beginning with $RunProton and the arguments /init and
/log).
2 participants
Description of the proposed changes
When I was following the instructions for setting up the development environment, I noticed that some of them were no longer up to date. I also moved
init_local_development.luato the folder specified in the guide. I assume this was missed at the time.Checklist
- [ ] Changes are annotated, including comments where usefulSummary by CodeRabbit
Documentation
Changelog