-
Notifications
You must be signed in to change notification settings - Fork 16
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
fix: update links in header and footer #87
Conversation
Can we have a preview link? |
https://rocmdocs.amd.com/projects/alpha/en/rtd/ The static content is obtained from the main branch, so the watermark won't appear until this is merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestion, overall lgtm.
Some notes on commit prefixes:
- docs is for the projects own documentation, i.e. changes that only affect this projects docs most of the changes in this PR should be
feat:
- IMO reverting should either be in
git revert
styleRevert "<original commit>"
or with the typerevert:
(I would prefer option 1)
Any change that results in downstream changes should be "feat" or "fix", with breaking changes noted when required, as these are the only prefixes that trigger a new version number.
docs/.gitignore
Outdated
/_images | ||
/_static | ||
/_templates |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Building the docs should no longer generate these, that's why I removed them from the ignore list.
If you just delete them from your working tree then they shouldn't come back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed in c479e7b
.gitignore
Outdated
@@ -4,3 +4,4 @@ dist/**/* | |||
**/__pycache__/**/* | |||
**/*.egg-info/**/* | |||
.sass-cache/* | |||
build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
build | |
/build |
We don't want it applied to sub folders containing build
. Btw what creates this folder?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in c479e7b
This gets built when I install a local version of rocm-docs-core for testing via pip install <dir>/rocm-docs-core
preserveAspectRatio="xMidYMid meet"> | ||
|
||
<g transform="translate(0.000000,77.000000) scale(0.100000,-0.100000)" | ||
fill="#000000" stroke="none"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fill="#000000" stroke="none"> | |
fill="#a0a0a0" stroke="none"> |
Tweaking this to mid-gray and adjusting the opacity to 20% makes the watermark also visible on the dark theme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Changes made in 7ccebb9
needed for myst parser in ROCr tested with ROCr locally
I have rebased and edited the commit messages to match. |
also adds alpha watermark