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

Increased Clarity for Pro Features in Documentation #1

Open
TingleyWJ opened this issue Aug 8, 2018 · 3 comments
Open

Increased Clarity for Pro Features in Documentation #1

TingleyWJ opened this issue Aug 8, 2018 · 3 comments
Labels
enhancement New feature or request

Comments

@TingleyWJ
Copy link

Quick Description

Add a stamp, image, or otherwise clear marker at the top of each page of documentation as to whether the specified class, interface, or other is Free or Pro.

For Feature Requests

Entire documentation would benefit from having visual Free/Pro clarification at the top of each page.

Some current examples where it would help are:
Timer Class: Pro, but missing the remark stating that it was Pro, so it isn't known (bug, but pointed out in discord).
Plugin.BadWorldFilter: Pro, but marked at the bottom of the page in plain text as Pro only. Not immediately visible.

@JamJar00
Copy link
Member

Thanks TingleyWJ!

I'll look into how I can make this more obvious, their should at least be a standard place for notices so I'll get that done for the next version.

Jamie

@JamJar00
Copy link
Member

The next version should have these a bit more standardized, they'll all be in the remarks section which isn't ideal but should be a bit bolder (I can't make them standout brilliantly because of the software that generates the docs).

I'll leave this open so I remember to look into this if I switch to DocFX instead!

@JamJar00 JamJar00 transferred this issue from DarkRiftNetworking/DarkRift Dec 16, 2018
@JamJar00
Copy link
Member

@TingleyWJ I've transferred this to the new documentation repository. Hopefully, we can do a bit more about this now we're on DocFx!

@JamJar00 JamJar00 added the enhancement New feature or request label Dec 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants