typedb-docs
typedb-docs copied to clipboard
Found Broken Link on "typedb.com/learn" with link text "Crash Course"
Description of issue
FYI: There is a broken link on the typedb.com/learn page; the link is near the top of the page, with the text "Crash Course"
Broken Link: https://typedb.com/docs/home/crash-course/get-started/
There are also duplicated references to 'quick start' or 'get started' below the first links on the page; this all needs to be revised & cleaned up.
Further down that page, under the heading "Learning TypeDB and TypeQL", all the links point to documentation from TypeDB v2, and are now out of date. Please either revise those articles for v3, or remove the links to the v2 articles on the typedb.com/learn page.
Further down that same page, under the heading "Building your first application", the link for Rust goes to "typedb.com/docs/drivers/rust/tutorial" and then gets redirected to "typedb.com/docs/home/install/drivers"; this link should instead go directly to "typedb.com/docs/home/install/drivers#_rust".
A similar issue exists for every single link in that section.
Then, once I found the correct driver (Rust) at this link – "typedb.com/docs/home/install/drivers#_rust" – there is a sub-heading that says "Rust driver tutorial", which contains a link to Github.
However, if you try to follow that link to Github, you'll get a 404 page.
Perhaps you meant to direct users towards the "example.rs" file located within the 'Rust' directory in the "typedb/typedb-driver" repo?
If so, the correct link is: "github.com/typedb/typedb-driver/blob/master/rust/example.rs"
Going back to the typedb.com/learn page... further down that page, under the heading "The theory behind TypeDB", the link with the text "TypeQL: a Type-Theoretic and Polymorphic Query Language" points to "typedb.com/papers/typeql-theory" – that page does not exist.
However, I found a link to "Papers" under the "Resources" section in the footer of the typedb.com/learn page; if I follow that link, it takes me to the "typedb.com/papers" where the article featured at the top is "TypeQL: a Type-Theoretic and Polymorphic Query Language" – great!
However, the "Download" button near the bottom right of that section takes me to... the same "typedb.com/papers/typeql-theory" page that did not exist when I tried to access that same link from the "typedb.com/learn" page!
But I guess that's OK, because there's 2 other articles on the "Papers" page that look very interesting; I'll read those instead.
But when I click on the "Download" link under the paper titled "Type Theory as a Unifying Paradigm for Modern Databases", which is going to take me to the link "typedb.com/papers/type-theory-paradigm", I get... another 404.
I'm starting to sense a pattern here, and I don't think I even need to access a DB & compute summary stats to detect this pattern...
But, there's one last paper listed on that page, and that paper looks to be the the most interesting out of the three. But when I try to click the "Download" button for the paper titled "The Role of Symbolic AI with ML in Robotics", I get... another 404.
However, after examining every link on the "typedb.com/papers" page, there is one link (aside from the footer) that actually works: in the section describing the TypeQL language the link with the text "Read Announcement and Summary" does work – good job! I can at least read the blog post about the theory behind TypeQL.
Once you get to the blog post located at "typedb.com/blog/towards-typeful-database-languages", there's another couple of links that taunt me into clicking them - they promise that I can "Download PDF".. I see that same text twice on the blog post page, but both times... I'm right back at the "typedb.com/papers/typeql-theory" page, and it's still a 404.
I think it's time to give up – this website is much too frustrating...
Maybe in a few days I'll come back and read up on "The TypeDB 3.0 Roadmap", which is described & linked to near the bottom of the typedb.com/learn page...
Wait – wasn't TypeDB 3.0 released months ago? I thought we were up to TypeDB v3.5 already..?
I'm confused.. is there new information on the Roadmap page?
Or is it like the links above this, that pointed me back to the documentation for TypeDB 2.x.x..?
I'm guessing TypeDB would be a lot more successful onboarding new users & customers if they stopped insisting on confusing & frustrating them endlessly...
Or maybe this is some meta statement about how confusing Type Theory can be..?
(if so, it's working!)
Affected docs article
typedb.com – website
Suggested solution
See above.
Thanks for the feedback. We should definitely be doing a better join maintaining our old links!
The reason you're running into that cycle is that we're in the process of revamping the /learn pages and other things that are currently outside the typedb.com/docs domain.
We're working on revamping the rest of the site to bring it all up into a cohesive state.
cc @alexjpwalker and I'll point this issue out to Cal as well!
On that note i've found https://matthewsetter.com/writing-tools/npm-broken-link-checker/ BLC to be working quite well for automated link checking!