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 bsconfig documentation #1024

Conversation

josephjunker
Copy link
Collaborator

@josephjunker josephjunker commented Jan 22, 2024

The current README feels a little intimidating to me because of how long it is, so this PR pulls some of the details from it out into their own pages.

List of changes:

  • Add minimal bsconfig.json example, copied from the brighterscript-template project
  • Make a new page for bsconfig documentation
  • Make a new page for documentation on suppressing error messages
  • Edit "extends" and "optional extends" sections to reduce duplication
  • Alphabetize bsconfig documentation
  • Add table of contents for bsconfig documentation
  • Add cross-links to bsconfig documentation, connecting sections together
  • A few tweaks to markdown formatting which do not affect the rendered page, such as adding or removing some extra newlines for consistency
  • Remove reference to ignoreErrorCodes flag in "bs ignore" documentation
  • Remove self-effacing statement about project being likely to contain bugs in "bs ignore" documentation :)

Other than these changes, the text is solely rearranged from the current version with no modifications. If desired I can undo some of these changes, such as not alphabetizing the documentation.

I've manually tested all of the links within the bsconfig documentation page but the use of absolute hyperlinks prevents me from manually testing the links from the error suppression documentation page to the bsconfig documentation page.

@josephjunker josephjunker force-pushed the junker/refactor-bsconfig-documentation branch from 86eaa6b to 22d3c27 Compare January 22, 2024 17:44
Copy link
Member

@TwitchBronBron TwitchBronBron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Thanks so much!

@TwitchBronBron TwitchBronBron merged commit 7bb1892 into rokucommunity:master Jan 24, 2024
6 checks passed
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.

None yet

2 participants