Skip to content

Conversation

IAmNotHanni
Copy link
Member

@IAmNotHanni IAmNotHanni commented May 23, 2021

Work in progress:

Closes #553
Closes #484
Closes #520
Closes #388

  • Rebase onto main
  • Improve GitHub repo main page
  • Add reference page about error handling using exceptions
  • Merge pages in engine-design section into one page
  • Refine FAQ section
  • Fix source code view (integration of doxygen's output)
  • Make docs front page consistent with vulkan-renderer repo's front page
  • Add links to new Vulkan material
  • Add links to new modern C++ material
  • Write down our standard for code documentation using comments in a reference page
  • Explain why CPU/GPU multithreading is important in documentation
  • Move platform support into "Getting Started" and move "Getting Started" to the top
  • Merge "Getting Started" with "Build Instructions"
  • Remove CHANGELOG.rst to avoid duplication and just redirect to GitHub release page

Postponed:

@IAmNotHanni IAmNotHanni added the cat:documentation documentation label May 23, 2021
@IAmNotHanni IAmNotHanni self-assigned this May 23, 2021
@IAmNotHanni IAmNotHanni marked this pull request as draft May 23, 2021 10:17
@IAmNotHanni IAmNotHanni force-pushed the hanni/wiki_update_4 branch from 84322a1 to bea8a34 Compare June 19, 2022 11:20
@IAmNotHanni

This comment was marked as outdated.

@IAmNotHanni IAmNotHanni changed the title [doc] Update 4 [doc] Update and Improve Documentation, part 4 Oct 11, 2025
@IAmNotHanni IAmNotHanni changed the title [doc] Update and Improve Documentation, part 4 [doc] Update and improve documentation, part 4 Oct 11, 2025
@IAmNotHanni IAmNotHanni force-pushed the hanni/wiki_update_4 branch 2 times, most recently from ab7760e to f668f76 Compare October 13, 2025 20:12
@IAmNotHanni IAmNotHanni marked this pull request as ready for review October 13, 2025 20:14
@IAmNotHanni IAmNotHanni merged commit 251fadb into main Oct 13, 2025
17 checks passed
@IAmNotHanni IAmNotHanni deleted the hanni/wiki_update_4 branch October 13, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cat:documentation documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation error Remove recommonmark requirement Update documentation Improve reference page about octree collision detection

1 participant