-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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] Delete embedded documentation in favor of docs/ #25096
[docs] Delete embedded documentation in favor of docs/ #25096
Conversation
Drive-by for the helper ports: 1. "documentation": "https://vcpkg.io/en/docs/README.html" 2. "license": "MIT" 3. Use `include_guard(GLOBAL)` in all script files 4. Make sure any persistent variables are saved to the cache
strictly speaking you cannot have the docs of scripts ports in |
We did discuss that as well (it was one of my concerns). Our approach moving forward will be to include "Added in version x-y-z" annotations where appropriate in future documentation changes. We won't be "backdating" any existing documentation. |
Rather than adding an empty regenerate.ps1 can you just delete this block that was calling it? vcpkg/scripts/azure-pipelines/windows/azure-pipelines.yml Lines 49 to 56 in 203f5f3
|
I'm going to go ahead and merge since the previous c645bad passed. |
From draft to world rebuild in less than 24 hours... But I'm glad this documentation update barrier is removed. |
After discussion, we've determined that maintaining the documentation inside the port where fixing typos requires republishing the port, is problematic.
This PR performs one final regenerate run (including the missing port helpers
vcpkg-qmake
andvcpkg-get-python-modules
) and then purges all embedded documentation in the script helpers and port helpers.This PR does not touch any of the content of this documentation -- that will be done in follow-up PRs.
Drive-by for the helper ports:
include_guard(GLOBAL)
in all script files