docs.openzeppelin.com

docs.openzeppelin.com copied to clipboard

Sidebar improvements

1

There's several improvements we can/should make to the sidebar. - [ ] Remember scrolling position (+ collapsed items?) when navigating between pages. - [x] Change cursor to pointer when hovering...

frangio

For smart contract documentaiton we're currently only showing the `@dev` NatSpec entries. We should also show `@param` documentation.

frangio

Consider deploying at subdirectory instead of subdomain

5

Keeping the docs at a subdirectory (ie openzeppelin.com/docs) is better for SEO than using a subdomain (ie docs.openzeppelin.com) (read [here](https://blog.cloudflare.com/subdomains-vs-subdirectories-best-practices-workers-part-1/)). > If you're a startup or small business looking to...

spalladino

Broken xref internal links are rendered as anchors to current page

3

An incorrect internal xref link, such as `xref:upgrades::writing-contracts.adoc` instead of `xref:upgrades::writing-upgradeable.adoc` (see https://github.com/OpenZeppelin/openzeppelin-sdk/commit/1b21b2946b889ae85651d8e7318ff2e8118a725c) is rendered as a link to `https://docs.openzeppelin.com/cli/2.6/dependencies#upgrades::writing-contracts.adoc#use-upgradeable-packages`. This makes it impossible to detect broken links with a...

spalladino

Create automation to merge docs changes to the branches used for the site

1

From #47 The docsite is deployed from specific branches of each repo (usually `docs-v*`). This is good because it prevents new documentation for unreleased features to show up on the...

nventuro

In https://github.com/OpenZeppelin/openzeppelin-contracts/pull/2058, @frangio mentioned he doesn't agree with some aspects of the current writing style in our docs, including: * having colons before a list starts * capitalizing after colons...

nventuro

Include a link to our audits service in the warning boxes

2

From https://github.com/OpenZeppelin/docs.openzeppelin.com/issues/47

nventuro

As part of the CI checks, ensure that the docsite has no broken links. Check if there is an npm package to handle this. Alternatively, the following command uses wget...

spalladino

Each page could have an `Edit this page` button/link at the bottom of the page which is a link to the page in the repo, so that community members can...

abcoathup

Favicon does not show in browser

2

Favicon does not show in browser, even though these are defined here https://github.com/OpenZeppelin/docs.openzeppelin.com/blob/master/ui/theme/partials/layout.hbs#L26  It currently only appears to work on Firefox, but not...

ericglau