NEW Duet3D documentation site - now official!

droftarts

You may have noticed a few threads on the forum recently, and the subtle notifications on Dozuki, that have pre-empted this announcement, but I'm happy to say that we are making it official; the new Duet3D documentation wiki is open for business.

https://docs.duet3d.com/

The wiki has been re-organised to make it more accessible and discoverable. Nearly all pages have been updated with RRF 3.x and Duet 3 information. Pages have tabs, so users can select to see content that is relevant to their setup only. The single page GCode dictionary is back! (We currently have individual GCode pages that redirect to the relevant GCode in the single page; this is in anticipation of a forthcoming feature of wiki.js, and should mean that we can have both the single page and individual pages driven from the same text 'snippet'.)

There is still some work to do; rewriting the how-to guides, and writing new ones, is especially time-consuming. There are some tweaks to design and layout to come, too. We will be allowing users to create accounts and edit pages soon, but for now we are taking it slowly to avoid spam.

Regarding the Dozuki site, you may have noticed the subtle redirect message at the top of every page. As of the beginning of March 2022, the Dozuki site will no longer be maintained. There are a small number of edits that need to be integrated, but otherwise only the new wiki will be updated. If you have content on the Dozuki site that hasn't been migrated, please get in touch and we'll sort out what can be moved across. Eventually, the Dozuki site will be taken down; we will try to give you notice of when this is happening, in case there's anything you want to save from it.

Please do post your feedback on the new documentation site; it has taken a long time to get to this stage, and has been my main focus for 6+ months (so be gentle)! Like Dozuki, there are limitations to what can be achieved, but we feel, after testing quite a number of different wiki solutions, this gives the best experience for users while being manageable for the Duet3D team.

Enjoy! (Also, I've read literally every word of the wiki; if you need to find something and can't, just ask!)

Ian

pixelpieper

@droftarts Well done, this looks so much better than the Dozuki, must have been a ton of work.

mikeabuilder

Outstanding work, Ian. I posted a couple of things yesterday here: https://forum.duet3d.com/topic/27585/documentation-suggestions

Two other things that might be useful - a "wish list" for the wiki, and some pointers to people that might want to get ready for future contributions (editor suggestions, for example).

I know that eventually people will get accounts and be able to contribute directly, but some people want to learn something and can;t be contributors, while others might contribute new content if they knew what people were looking for. My personal example is that I'm characterizing my own printer and would love to read about all the things that go into the Duet fw managing print head dynamics. I'm a retired mech engineer so I'm going through the process of figuring out how "it must be getting done". Once I convert that into "what's really happening", I'd be happy to contribute a page to share that info.

gwatson90

Thank you for all your time and effort, it's great to have a company that values the time of its users! I'm looking forward to using custom tabs to my hearts' content.

OwenD

@droftarts
The new docs look flashier than a rat with a gold tooth!
Well done

droftarts

@owend said in NEW Duet3D documentation site - now official!:

The new docs look flashier than a rat with a gold tooth!

Thanks... I think! And thanks to everyone else!

Ian

MaxGyver

@droftarts

Wow, this is great! I really apreciate that you make the effort to constantly improve the and update the documentation.

Good Job!

oliof

Here's some feedback I've been asked to forward by someone who doesn't frequent the forum:

The site doesn't work very well on mobile currently: The hamburger menu icon doesn't show on mobile for until you scroll down and then clicking it the animation hitches then it is loaded already scrolled down and also messes up the page width as well.

So mobile CSS might need some looking at.

Even though the GCodes are now on one page again, there is no easily accessible index of GCodes. It's also not really possible to browse an index of GCodes on mobile (and even on a normal laptop, the "page content" sidebar barely shows usable information). An easily accessible readable index of GCodes -- grouped by category as a bonus -- would be very welcome.

For the mobile display issue:

1st image, search isn't showing, hamburger menu isn't showing
2nd image, hamburger menu shows
3rd image, pressing on hamburger menu shows the menu as scrolled before
4th image, search isn't showing properly

And you can see that the main content width is jumping around when you try to use the menu or search.

EDIT: The issue with the hamburger menu and the search bar seems to be only for the long GCodes reference page.

oliof

And I just stumbled upon https://docs.duet3d.com/User_manual/Reference/Gcodes_by_function which seems to be the reference list I requested.

o_lampe

@droftarts
Is there a way to customize the theme of the page, like the dark theme in DWC? I really have trouble reading lengthy texts in black letters on white background. Especially when it's not just trivial novel stuff, but things I have to understand word for word.

T3P3Tony

@o_lampe apparently themes will be part of wiki Js 3.x

T3P3Tony

@oliof yes I see the same issue with the gcode dictionary page on mobile, it looks to be caused by test not wrapping in the custom formatting we are using for code examples on that page. We will investigate

droftarts

@oliof Thanks for the feedback. I haven't seen these issues on iOS, even on the GCode page, and search results show correctly, too. @T3P3Tony is checking them on Android. I think you're using the Brave browser, which I haven't tried/tested.

I find the lack of a hamburger menu for the Table of Contents on mobile annoying. Glad you found the GCode by function page! It is also on Dozuki.

@o_lampe @T3P3Tony beat me to it.

Ian

T3P3Tony

@oliof i believe the issue on the Gcode-dictionary page is now fixed where the long lines of code were making the page behave in that way.

now on that page the search button and hamburger menu behave as expected.

jay_s_uk

@t3p3tony it would be helpful to be able to expand the size of the scrolling menu on the gcode page or enable wrapping of text as some items you can't see the full description of the gcode without clicking it

T3P3Tony

@jay_s_uk can you test this now pls

jay_s_uk

@t3p3tony Much better!

gallaghersart

Love It.

I do not know if this is planned but a simple / complex .htaccess on original site will auto send people to correct pages on new site and allow search engines to quickly update the links.

I think like on
https://duet3d.dozuki.com/.htaccess

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule ^Wiki/M303/ https://docs.duet3d.com/User_manual/Reference/Gcodes#m303-run-heater-tuning [L,R=301]
RewriteRule ^c/Individual_Gcodes/ hhttps://docs.duet3d.com/en/User_manual/Reference/Gcodes [L,R=301]
</IfModule>

T3P3Tony

@gallaghersart part of the issue with a site like dozuki is no access to .htaccess or equivalent. The big headline is what we can do.

gallaghersart

@t3p3tony
There are other ways of doing this, would be glad to message someone / help.

But as long as the old docs are online search engines will serve up that one. Once OLD system is off line it could still take a week or so to get search engines on new site with out helping them.

Using 301 redirects is best as it keeps your search status and proof of long lasting good website.

Could add meta to each html page
<meta name="robots" content=”none”> and? noimageindex, nosnippet, nofollow, etc.

Can also do same as .htaccess if using PHP and other ways.

Less friendly can do html redirect but not good to fix Search Engines.

If you have Goolge/bing/etc webmaster tools and all pages have <meta name="robots" content=”none(or more)”> on old site and <meta name="robots" content=”all”> on new site they may have tools to directly find your new links and remove old.

At the bare minimum have all pages on old sites <meta name="robots" content="index, follow" /> CHANGED to <meta name="robots" content="none, nofollow, nosnippet" />.

Also my example of .htaccess turned into a link. that files does not work as link. it is in root folder of your public web folder. ftp and other programs need to allow to see hidden files. Even if host says you have no access to .htaccess you might still be able to edit. Or create new if does not exist.

Would be glad to help.
`mike