search

snake-biscuits / bsp_tool

Python library for analysing .bsp files
GNU General Public License v3.0
104 stars 8 forks source link

Refactor GitHub Pages #126

Open snake-biscuits opened 1 year ago

snake-biscuits commented 1 year ago

README Badges

I'd like to move the whole big list of supported games out of README (done!) We could docs/generate coverage badges as part of GitHub Actions Much less painful than manually updating the README all the time too

docs.supported could use a refactor in general, the generator is a mess docs.timeline would be a lot nicer if it was generated instead of handmade ascii diagrams

Database

Each table will be checked off when sufficiently populated

Branches

For docs.branches; Linked to just about everything

  • [x] Engine
  • [x] Developer
  • [x] Branch
  • [ ] BranchFork

Citations

For docs

  • [ ] Reference
  • [ ] Citation

Companies

For docs.timeline

  • [ ] Company
  • [ ] CompanyFork
  • [ ] CompanyMerge
  • [ ] ReleaseDeveloper
  • [ ] ReleasePublisher
  • [ ] ParentCompany
  • [ ] PlatformCompany

Coverage

For docs.branches

  • [ ] Lump
  • [ ] Script
  • [ ] LumpClass
  • [ ] BranchLumpClass

Games

For docs.timeline

  • [ ] Game
  • [ ] Relation
  • [ ] GameRelation
  • [ ] Series
  • [ ] GameSeries

Releases

For docs.timeline

  • [ ] Platform
  • [ ] Region
  • [ ] Release
  • [ ] ReleaseBranch

Tools

For docs.branches

  • [ ] LevelEditor
  • [ ] Compiler
  • [ ] Utility
  • [ ] CompilerUtility
  • [ ] PostCompiler
  • [ ] ToolFileFormat
  • [ ] LevelEditorFormat
  • [ ] CompilerFormat
  • [ ] BranchLevelEditor
  • [ ] BranchCompiler
  • [ ] BranchPostCompiler
snake-biscuits commented 1 year ago

Probably want to generate a coverage rating for each branch based on megatest.log The current tests/megatest.py refactor means that log can just be the megatest

Indexing & grouping PASS / FAIL / XFAIL states for each developer.branch could get annoying Will need some kind of database (can pytest output to .csv)?

pytest-cov lines covered could also tell us which LumpClasses aren't in test maps

snake-biscuits commented 1 year ago

This has rapidly devolved into a total refactor of docs, more automation will be nice tho

snake-biscuits commented 1 year ago

The "Coverage" chunk of the database will involve existing refactor plans:

snake-biscuits commented 1 year ago

"Company", "Game", "Release" & "Citations" all tie into docs.timeline: