Skip to content

Polish Livia Panel open-source documentation - #7

Merged
akndrn000 merged 9 commits into
mainfrom
docs/open-source-readme-polish
Oct 18, 2026
Merged

akndrn000 merged 9 commits into
mainfrom
docs/open-source-readme-polish

Conversation

@akndrn000

Copy link
Copy Markdown
Collaborator

Summary

  • Refresh both README files with dynamic license and documentation-check badges, clearer project overview, and consistent navigation.
  • Add official Roblox/Luau source references and explain what the existing MIT license covers without replacing it.
  • Add CONTRIBUTING.md and SECURITY.md.
  • Add a standard-library documentation checker for local Markdown/HTML file references and SVG XML validity.
  • Add a least-privilege GitHub Actions workflow to run the documentation checks.
  • Clarify that the SVG diagrams are generated project artwork, not live Roblox screenshots.
  • Strengthen the responsible-use warning and link to Roblox's official policy on cheating/exploiting.

Validation

  • The checker uses Python's standard library only and is documented in both READMEs.
  • The automated check is intentionally described as documentation validation, not a Roblox runtime test.
  • Existing Lua source and MIT LICENSE remain unchanged.

@akndrn000
akndrn000 merged commit 3f6a325 into main Oct 18, 2026
1 check passed
@akndrn000
akndrn000 deleted the docs/open-source-readme-polish branch October 18, 2026 13:24
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.

1 participant