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

[DOC-BUG] Fix 404 in "Understanding WooCommerce Endpoints" #47567

Closed
Brianmitchtay opened this issue May 17, 2024 · 2 comments
Closed

[DOC-BUG] Fix 404 in "Understanding WooCommerce Endpoints" #47567

Brianmitchtay opened this issue May 17, 2024 · 2 comments
Assignees
Labels
focus: documentation Issues and PRs related to improving documentation team: Developer Advocacy

Comments

@Brianmitchtay
Copy link

Link to the Page/Section

Provide a link to the specific page or section that you're referring to.

https://developer.woocommerce.com/docs/woocommerce-endpoints/
https://github.com/woocommerce/woocommerce/blob/trunk/docs/getting-started/woocommerce-endpoints.md

In the "Learn More" section at the bottom Customizing endpoint URLs links to a 404 - https://developer.woocommerce.com/docs/woocommerce-endpoints/docs/customizing-endpoint-urls

The article is at - https://developer.woocommerce.com/docs/customizing-woocommerce-endpoint-urls/

Description of the Suggestion

Describe the changes you suggest to improve or correct the documentation. Be specific about any errors or areas of confusion you've identified.

It looks like these relative links in the markdown files should be correctly targeting the docs we want, but it's not rendering that way.

I'm not sure what system is being used to render the dev docs, but if it supports root relative URLs we could potentially reformat the markdown on the page to:

- [Customizing endpoint URLs](/docs/woocommerce-endpoints/customizing-endpoint-urls.md)
- [Troubleshooting endpoints](/docs/woocommerce-endpoints/troubleshooting-endpoints.md)

Reason for the Suggestion

Why do you believe this change will make the documentation clearer or more accurate?

We should avoid 404's where possible, this may be a broader issue.

@rrennick
Copy link
Contributor

- [Customizing endpoint URLs](/docs/woocommerce-endpoints/customizing-endpoint-urls.md)
- [Troubleshooting endpoints](/docs/woocommerce-endpoints/troubleshooting-endpoints.md)

Changing to these links will not work. I ran Refresh from source on this doc in my dev install and the links in the learn more section are correct.

@piinthecloud
Copy link
Collaborator

We have fixed the issues by running Refresh from source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: documentation Issues and PRs related to improving documentation team: Developer Advocacy
Projects
None yet
Development

No branches or pull requests

6 participants