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

Refactor GitHub Pages #126

Open
3 of 37 tasks
snake-biscuits opened this issue Aug 12, 2023 · 4 comments
Open
3 of 37 tasks

Refactor GitHub Pages #126

snake-biscuits opened this issue Aug 12, 2023 · 4 comments
Assignees
Labels
documentation This issue involves a lack of documentation refactor requires restructuring some backed stuff slow burn lots of work & will take a long time

Comments

@snake-biscuits
Copy link
Owner

snake-biscuits commented Aug 12, 2023

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

  • Engine
  • Developer
  • 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 snake-biscuits added the documentation This issue involves a lack of documentation label Aug 12, 2023
@snake-biscuits snake-biscuits self-assigned this Aug 12, 2023
@snake-biscuits
Copy link
Owner Author

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 snake-biscuits added the refactor requires restructuring some backed stuff label Oct 3, 2023
@snake-biscuits snake-biscuits changed the title Badges in README [docs.generate] refactor README & GitHub Pages Oct 7, 2023
@snake-biscuits
Copy link
Owner Author

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

@snake-biscuits
Copy link
Owner Author

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

@snake-biscuits
Copy link
Owner Author

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

@snake-biscuits snake-biscuits changed the title [docs.generate] refactor README & GitHub Pages Refactor GitHub Pages Aug 29, 2024
@snake-biscuits snake-biscuits added the slow burn lots of work & will take a long time label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue involves a lack of documentation refactor requires restructuring some backed stuff slow burn lots of work & will take a long time
Projects
Status: Todo: Research
Development

No branches or pull requests

1 participant