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

docs: Overhaul and organize all of the existing documentation we have #412

Merged
merged 2 commits into from
May 2, 2021

Conversation

xTVaser
Copy link
Member

@xTVaser xTVaser commented May 2, 2021

Preview changes here - https://xtvaser.github.io/jak-project/api-docs.html#/type_system (may be some caching / CDN issues, overview page is stubborn to load but should)

There isn't any new documentation, just cleaned up and organized the markdown / removed duplicate documentation. Added syntax highlighting / a plugin to copy paste code examples out of the docs (any code blocks).

I think this is sufficient to close #371 documentation can always get better but, this feels like a pretty good start to me.

@coveralls
Copy link

coveralls commented May 2, 2021

Pull Request Test Coverage Report for Build 803589881

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 69.276%

Totals Coverage Status
Change from base Build 803312863: 0.0%
Covered Lines: 34266
Relevant Lines: 49463

💛 - Coveralls

@water111 water111 merged commit 928cb48 into open-goal:master May 2, 2021
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.

[OpenGOAL Language] Create a usable manual
3 participants