Skip to content
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

Update various documentation dead links and typos #1028

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AlexandreArpin
Copy link

I encountered a couple of dead links and typos in the documentation. I removed the 404 links and empty documentation pages.

There's a new version of mkdocs that added a breaking change to the mkdocs.yml file (pages becomes nav)

I think the readthedocs hasn't been refreshed/redeployed in a while because there's still an issue with the missing end code block on https://netmq.readthedocs.io/en/latest/message/ that was fixed in #1012

Copy link
Member

@drewnoakes drewnoakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a new version of mkdocs that added a breaking change to the mkdocs.yml file (pages becomes nav)

Are you able to update that file too?

Comment on lines -1 to -10
Devices
===

See:

* http://api.zeromq.org/2-1:zmq-device
* `IDevice` and `DeviceBase`
* `ForwarderDevice`
* `QueueDevice`
* `StreamerDevice`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why delete this file?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can recover it, it wasn't linked in the sidebar and with the current content, I thought it was an incomplete page to be honest.

@AlexandreArpin
Copy link
Author

There's a new version of mkdocs that added a breaking change to the mkdocs.yml file (pages becomes nav)

Are you able to update that file too?

I can, I'm not 100% sure how the mkdocs version is resolved through the GitHub Pages mechanism but I can run it locally.

Want me to apply the changes so that it works with the latest version of mkdocs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants