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

Broken links in Creator manual & API-ref top bar, broken / outdated API-ref links, broken Creator API-ref version picker #994

Closed
rChaoz opened this issue Aug 21, 2019 · 2 comments
Assignees
Labels

Comments

@rChaoz
Copy link

rChaoz commented Aug 21, 2019

In any page of the Creator Manual or Creator API-ref:
https://docs.cocos2d-x.org/creator/manual/en/
https://docs.cocos2d-x.org/creator/api/en/

In the top bar, the Cocos2d-x Manual link is broke. It points to:
https://docs.cocos2d-x.org/cocos2d-x/en/
(403 forbidden error)
It should point to:
https://docs.cocos2d-x.org/cocos2d-x/v3/en/

Also, in the api-ref index page: https://docs.cocos2d-x.org/api-ref/index.html
The Cocos Creator API ref says "v1.9 Cocos Creator" when it should say just "Cocos Creator", since there is only one Cocos Creator API-ref page with it's own version picker. Either way the link is broken, it points to:
https://docs.cocos2d-x.org/creator-api/en/
(403 forbidden error)
It should point to:
https://docs.cocos2d-x.org/creator/api/en/

Also the version picker in said page: https://docs.cocos2d-x.org/creator/api/en/
does not work properly - when picking version '1.9' it displays 'Cocos Creator v2.1' as the title. I don't know if only the version number is incorrect or if it's showing the 2.1 version docs (as the link is /1.9/api/en). And finally, I believe that, since version 2.0 is no longer maintained and its features have been merged into 2.1, the default version that shows when accessing the Creator API-ref should be 2.1 instead of 2.0.

@rChaoz rChaoz changed the title Broken links in Creator manual & API-ref top bar / footer, broken / outdated API-ref links, broken Creator API-ref version picker Broken links in Creator manual & API-ref top bar, broken / outdated API-ref links, broken Creator API-ref version picker Aug 21, 2019
@xunyi0 xunyi0 self-assigned this Aug 22, 2019
@xunyi0
Copy link
Contributor

xunyi0 commented Sep 20, 2019

In any page of the Creator Manual or Creator API-ref:
https://docs.cocos2d-x.org/creator/manual/en/
https://docs.cocos2d-x.org/creator/api/en/

I did not find any broke link in Creator Manual or Creator API-ref, could you please help to mark it?

In the top bar, the Cocos2d-x Manual link is broke. It points to:
https://docs.cocos2d-x.org/cocos2d-x/en/
(403 forbidden error)
It should point to:
https://docs.cocos2d-x.org/cocos2d-x/v3/en/

This problem, I verified that the Cocos2d-x Manual link was correct, it points to https://docs.cocos2d-x.org/cocos2d-x/v3/en/

Also, in the api-ref index page: https://docs.cocos2d-x.org/api-ref/index.html
The Cocos Creator API ref says "v1.9 Cocos Creator" when it should say just "Cocos Creator", since there is only one Cocos Creator API-ref page with it's own version picker. Either way the link is broken, it points to:
https://docs.cocos2d-x.org/creator-api/en/
(403 forbidden error)
It should point to:
https://docs.cocos2d-x.org/creator/api/en/

This problem, I'll fix it up later.

Also the version picker in said page: https://docs.cocos2d-x.org/creator/api/en/
does not work properly - when picking version '1.9' it displays 'Cocos Creator v2.1' as the title. I don't know if only the version number is incorrect or if it's showing the 2.1 version docs (as the link is /1.9/api/en). And finally, I believe that, since version 2.0 is no longer maintained and its features have been merged into 2.1, the default version that shows when accessing the Creator API-ref should be 2.1 instead of 2.0.

Now, the default version that shows when accessing the Creator API-ref has changed to 2.1. If you need to view other versions, you can click the button above to switch:

image

@xunyi0 xunyi0 added the pending label Sep 20, 2019
@xunyi0
Copy link
Contributor

xunyi0 commented Sep 26, 2019

Thank you for your feedback. The document has been readjusted, you can check it.
If there are still any questions, please feel free to give us more feedback~

@xunyi0 xunyi0 closed this as completed Sep 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants