Skip to content

Add 5 user-facing wiki pages: FAQ, Quick-Start Tutorial, Editor Walkt…#347

Merged
Krilliac merged 1 commit into
Workingfrom
claude/expand-user-documentation-gdRYH
Apr 3, 2026
Merged

Add 5 user-facing wiki pages: FAQ, Quick-Start Tutorial, Editor Walkt…#347
Krilliac merged 1 commit into
Workingfrom
claude/expand-user-documentation-gdRYH

Conversation

@Krilliac

@Krilliac Krilliac commented Apr 3, 2026

Copy link
Copy Markdown
Owner

…hrough, Configuration Reference, Performance Tips

Expand documentation targeted at all users (not just engine developers):

  • FAQ: common questions about the engine, building, editor, gameplay, graphics
  • Quick-Start Tutorial: hands-on first 10 minutes experience
  • Editor Walkthrough: practical panel-by-panel guide with workflows
  • Configuration Reference: complete settings.ini reference, 150+ console commands, CVar system
  • Performance Tips: optimization guide for rendering, physics, audio, networking
  • Updated Home.md with role-based recommended reading paths
  • Updated _Sidebar.md with new pages in Getting Started and Advanced sections
  • Updated documentation coverage audit (83 → 88 wiki pages)

https://claude.ai/code/session_01KhfQJiAkHSHZ1EjRirTj1x

…hrough, Configuration Reference, Performance Tips

Expand documentation targeted at all users (not just engine developers):
- FAQ: common questions about the engine, building, editor, gameplay, graphics
- Quick-Start Tutorial: hands-on first 10 minutes experience
- Editor Walkthrough: practical panel-by-panel guide with workflows
- Configuration Reference: complete settings.ini reference, 150+ console commands, CVar system
- Performance Tips: optimization guide for rendering, physics, audio, networking
- Updated Home.md with role-based recommended reading paths
- Updated _Sidebar.md with new pages in Getting Started and Advanced sections
- Updated documentation coverage audit (83 → 88 wiki pages)

https://claude.ai/code/session_01KhfQJiAkHSHZ1EjRirTj1x
@Krilliac
Krilliac merged commit 7892beb into Working Apr 3, 2026
23 of 26 checks passed
@Krilliac
Krilliac deleted the claude/expand-user-documentation-gdRYH branch April 3, 2026 01:06
@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Code Coverage (GCC + lcov)

Utils/JsonUtils.h                         |    -      0|    -     0|    -      0
Utils/LocalFileCache.h                    |12.7%    157| 0.0%    20|    -      0
Utils/Logger.cpp                          |21.8%    133| 0.0%    17|    -      0
Utils/Logger.h                            |18.2%    121| 0.0%    20|    -      0
Utils/MathUtils.cpp                       |    -      0|    -     0|    -      0
Utils/MemoryDebugger.h                    |13.3%    150| 0.0%    20|    -      0
Utils/MemoryMonitor.cpp                   | 9.6%    229| 0.0%    19|    -      0
Utils/MemoryMonitor.h                     |85.7%     14| 0.0%    12|    -      0
Utils/OpaqueHandle.h                      | 209%     11| 0.0%    15|    -      0
Utils/Profiler.cpp                        |14.2%    113| 0.0%    15|    -      0
Utils/Profiler.h                          |36.4%     33| 0.0%    12|    -      0
Utils/RandomEngine.h                      |29.3%     41| 0.0%    12|    -      0
Utils/Result.h                            | 100%     29| 0.0%    28|    -      0
Utils/RingBuffer.h                        | 108%     59| 0.0%    64|    -      0
Utils/ScopeGuard.h                        | 142%     36| 0.0%    51|    -      0
Utils/ScopedTimer.h                       |25.0%     12| 0.0%     3|    -      0
Utils/Serializer.h                        | 100%     48| 0.0%    42|    -      0
Utils/SparkConsole.cpp                    | 125%     32| 0.0%     6|    -      0
Utils/SparkConsole.h                      | 100%      2| 0.0%     2|    -      0
Utils/SparkError.h                        |10.9%     55| 0.0%     6|    -      0
Utils/SplinePath.h                        |    -      0|    -     0|    -      0
Utils/StackTrace.h                        |11.0%     73| 0.0%     8|    -      0
Utils/StateMachine.h                      |54.0%     63| 0.0%    32|    -      0
Utils/StringUtils.h                       |18.8%    112| 0.0%    21|    -      0
Utils/ThreadDebugger.h                    |12.8%    148| 0.0%    19|    -      0
Utils/ThreadSafeQueue.h                   |27.5%     40| 0.0%    11|    -      0
Utils/UUID.h                              |43.2%     37| 0.0%    16|    -      0
Utils/Validate.h                          |    -      0|    -     0|    -      0

[/home/runner/work/SparkEngine/SparkEngine/SparkSDK/Include/Spark/]
IEngineContext.h                          |6700%      1| 0.0%     1|    -      0
Version.h                                 |    -      0|    -     0|    -      0
================================================================================
                                    Total:|35.1%  11953| 0.0%  2416|    -      0

@github-actions

github-actions Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

❌ CI Error Report

Failed jobs: windows-vs2022-Release
Errors: 0 | Test failures: 3 | Warnings: 1

Test Failures

Test Jobs
1/1 Test #1: SparkEngineTests .................***Failed 9.14 sec windows-vs2022-Release
[ FAILED ] Monitor_CombinedSummary (1.5ms, 2 assertions) windows-vs2022-Release
0% tests passed, 1 tests failed out of 1 windows-vs2022-Release
Compiler Warnings (1)
SparkEditor\Source\Panels\InspectorComponentRenderers_Gameplay.cpp(117,17): warning C4477: 'snprintf' : format string '%lu' requires an argument of type 'unsigned long', but variadic argument 1 has type 'SparkEditor::ObjectID' [build\SparkEditor\SparkEditor.vcxproj]

Updated: 2026-04-03T01:31:37Z — this comment is updated in-place, not duplicated.

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