HackerOne users: Testing against this community violates our program's Terms of Service and will result in your bounty being denied.

Lots of documentation links broken

As a newcomer to the Vanilla environment I check plenty of documentation of plugins, features, etc... but a lot of them seem to be somehow broken. I mean links from plugins like: http://vanillaforums.org/docs/jsconnect but also others related to core features. They all redirect to the index of the documentation and from there usually it's hard (or impossible) to find the thing you were allegedly linked to.

I'm guessing that, at some point, you redid the documentation url structure but you didn't change the links (or didn't provide a method to redirect to the proper page).

From now on I'll try to compile every broken link I find so we can, eventually, fix this.

Deprecatedzhgtonight

Comments

  • Some time ago I also thought that the documentation was not readable , even so the engine is fantastic. They could want you advance into self- hosted solutions :3B)

  • @Deprecatedz said:
    Some time ago I also thought that the documentation was not readable , even so the engine is fantastic. They could want you advance into self- hosted solutions :3B)

    I can see your point, yet it wouldn't make any sense to make the documentation less readable so you go to the hosted solution. Like any successful F2P developer knows, you don't get people to give you money by annoying them. You get their money giving them a great product for free and an EVEN BETTER service by paying.

    So I just think that they made a change in the structure but no one got the time/resources/disposition to change it, so... I will add my two cents, for whatever it's worth :)

    R_JDeprecatedz
  • @xDaizu said:

    I know mate, I was just kidding ;)

    @xDaizu said:
    So I just think that they made a change in the structure but no one got the time/resources/disposition to change it, so... I will add my two cents, for whatever it's worth :)

    <3

  • The spanish translation plugin has the following help box:

    This addon is a <b>locale</b>. You need to extract it to your <code>/locales</code> folder to install it. For more help with locales check out the help topic <a hreg="http://vanillaforums.org/page/Localization">.here</a>

    The "here" link is not clickable because of the "hreg" in the tag :p

  • @xDaizu the offical docs are on git hub they accept pull request

    https://github.com/vanilla/vanilladocs

    grep is your friend.

  • @x00 said:
    xDaizu the offical docs are on git hub they accept pull request

    https://github.com/vanilla/vanilladocs

    Well' I tried searching that repository for an "hreg" string and couldn't find it. Would you be able to guide me through the folder structure?

    Also, this last problem in particular seems like a page theme/template problem, not a documentation problem "per sé", though it affects the documentation accesibility.

  • x00x00 MVP
    edited May 2015

    Those are the old docs. Maybe you could check they are still accurate and contribute any information that is not aready in the current docs.

    Then I'm sure @linc would get rid of the old docs, or redirect to the new ones.

    grep is your friend.

  • hgtonighthgtonight ∞ · New Moderator

    @xDaizu Nice catch!

    I submitted a PR to the community repo here: https://github.com/vanilla/community/pull/29

    Search first

    Check out the Documentation! We are always looking for new content and pull requests.

    Click on insightful, awesome, and funny reactions to thank community volunteers for their valuable posts.

Sign In or Register to comment.