Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add a temporary BETA disclaimer in devel-docs #416

Merged
merged 1 commit into from May 23, 2014

Conversation

Projects
None yet
2 participants
Contributor

saivann commented May 22, 2014

Live preview: (merged)

This pull req adds a temporary disclaimer in devel-guide and devel-ref, mentioning that the documentation is in BETA. Along with the "Report an issue" button in the toc, I think these are reasonable measures to let us publish this documentation while it is partially reviewed by core developers.

The disclaimer is fixed-positioned so it appears even when people click on anchors, and it can be closed until the browser session ends (thanks @harding for the idea).

Contributor

harding commented May 22, 2014

LGTM. The only downside I see in my testing is that the warning can't be hidden when javascript is disabled. However, noscript users like myself are used to far worse artifacts, so this is fine by me.

Thanks, @saivann!

Contributor

saivann commented May 22, 2014

@harding Thanks! Yeah I also always like to provide graceful fallback for noscript users, but I don't see any trick I could use in this case in which the disclaimer would still be visible.

saivann added a commit that referenced this pull request May 23, 2014

Merge pull request #416 from bitcoin/devel-docs-disclaimer
Add a temporary BETA disclaimer in devel-docs

@saivann saivann merged commit 090c5df into devel-docs May 23, 2014

@saivann saivann deleted the devel-docs-disclaimer branch May 23, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment