A New Documentation Experience: Available Now for .NET Products

One team at a time, we are moving toward a single toolset used to author and publish documentation for each supported platform. I’m happy to say that we’ve published our first effort in this regard – you can now view our .NET documentation in a modern responsive format by visiting the following URL:

https://docs.devexpress.com

New and Previous Formats, Side-by-Side

From Google, you’ll land on our previous product documentation site. To find content on the new site, you can manually navigate to docs.devexpress.com and use the search box as needed. Within a few weeks (once conversion issues have been addressed), we’ll flip the switch and move to this new engine and archive our old site.

Where possible, the new documentation site will offer you to navigate to the same documentation article in our previous format. We are also going to update the current site with messages that invite you to view updated information, if available.

Note that certain topic types, such as overloaded methods or class constructors, had the URL format changed to better match the standards set by Microsoft's documentation resources. This means that manually replacing "documentation" with "docs" in the URL will not work for all pages, although it will work for some.

Portions of v18.1 Content are Available Only in the New Format

Functionality shipping with v18.1 is documented in the new system for the following products:

These teams have fully adopted our new internal authoring system. They have manually adjusted their content where automatic conversion failed. We don’t expect any formatting issues and encourage you to use the new documentation site when with these products.

UWP and Xamarin Content is Available in Previous Format Only

If you are using our UWP or Xamarin controls, note that their documentation is only available in our previous format.

What’s Next

Our Documentation and R&D teams will continue to address known conversion and formatting issues to complete the transition to a single documentation resource within a few weeks, possibly with the first v18.1 minor update. Until that time, we'll be publishing frequent fixes and updates to the new site, so don’t hesitate to report issues you encounter during use.

8 comment(s)
Yauhen Kuchynski

Looks really great! Once I even asked you to make docs and tickets responsive.

The only issue now is that it is not possible to view contents on mobile. Breadcrumb at top is visible, but it is impossible to move to nested articles.

But overall result is perfect. It s much easier to read docs now from mobile. Thank you!

17 May, 2018
S. Hartmann

Your new documentation formating looks promising.

I like the link from description to API-Reference, or better I think I would like it, if it is working :)

It always links to the same article

docs.devexpress.com/.../DevExpress.DataAccess.UI

best regards

Stephan

17 May, 2018
Benoit Mischler

I really miss the 'TOC/section/chapters' displayed on the left side of the old documentation system (the 'treeview like structure').

Sometimes, it's useful to have an 'overall structural overview' of the documentation instead of a 'one level at a time' navigation style...

Could you add an option to display this navigation structure ?

Benoit

18 May, 2018
Juan Antonio Trujillo Montenegro

I only see a blank page when entering docs.devexpress.com/eXpressAppFramework

18 May, 2018
Vladimir Abadzhev (DevExpress)

The documentation website should be back online shortly. Our team is working on it.

18 May, 2018
Vladimir Abadzhev (DevExpress)

@Yauhen, Benoit The tree disappears completely now on mobile devices or when simply making the browser narrow enough. In future updates we'll make the tree available on all resolutions.

21 May, 2018
Vladimir Abadzhev (DevExpress)

@S. Hartmann - That API Reference link in the top toolbar always navigates to the root topic within the API tree. We'll work on making these topics more usable and self-explanatory. And maybe a better place for these links would be within the tree - we'll need to run a few tests.

21 May, 2018
Michael Snyir

So far, not a fan.

Needs lots of work.

Seems to do a search I have to go all the way back to the getting stated

page, then choose win forms, blah blah...5 minutes latter.

Please put the search back on top of ALL your web pages.

Too many hoops to jump through.

The VB .Net code sample links don't work, very strange.

Seems like the old documentation should be the default, and a link to the

new stuff at the top, seems backwards.

I'm not crazy about being a beta tester when I need something right now.

sorry for the rant, I love the product.

15 August, 2018

Please login or register to post comments.