Updating the help menu#125
Merged
litelawliet merged 1 commit intodevelopfrom Sep 28, 2020
Merged
Conversation
adriengivry
added
Documentation
adriengivry
force-pushed
the
feature/new_help_menu
branch
2 times, most recently
from
a79aa96 to
c7d8f0c
Compare
The help menu (Accessible from the menu bar), has been updated to: +-----------------+ | GitHub | | Getting Started | | Scripting API | +-----------------+ | Bug Report | | Feature Request | +-----------------| | Version: 1.3.0 | +-----------------+ `Credits` section has been removed because it is redundant from what you'll find on the GitHub page. Morehover, as Overload is now a collaborative project, it will be hard to keep track of our contributors and could affect negatively the code (Lots of change in the help menu everytime a new contributor joins us). `Overload Website` link has been removed. Actually, our website unique goal is to bring users from search engines to our GitHub page. Our long term goal is to have all Overload documentation into our Wiki instead of dispatching it accross multiple websites, thus, the website is becoming pointless for our users. `Overload documentation`, which was a link to our sources documentation, has been removed. As Overload is now public and sources are documented, we do not need to have this online documentation. Any method/class/struct documentation can be found directly in the source code, and we should avoid having multiple ways to do the same thing to reduce maintenance costs.
adriengivry
force-pushed
the
feature/new_help_menu
branch
from
c7d8f0c to
8cc3ed1
Compare
litelawliet
approved these changes
Sep 28, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The help menu (Accessible from the menu bar), has been updated to:
Creditssection has been removed because it is redundant from what you'll find on the GitHub page. Morehover, as Overload is now a collaborative project, it will be hard to keep track of our contributors and could affect negatively the code (Lots of change in the help menu everytime a new contributor joins us).Overload Websitelink has been removed. Actually, our website unique goal is to bring users from search engines to our GitHub page. Our long term goal is to have all Overload documentation into our Wiki instead of dispatching it accross multiple websites, thus, the website is becoming pointless for our users.Overload documentation, which was a link to our sources documentation, has been removed. As Overload is now public and sources are documented, we do not need to have this online documentation. Any method/class/struct documentation can be found directly in the source code, and we should avoid having multiple ways to do the same thing to reduce maintenance costs.Fixes #111
Note: This PR isn't exactly addressing points of issue #111. However, I feel like these changes reflect more the vision of Overload's future (Documentation centralization) than the original issue.