New documentation is great

   5414   16   6
User Avatar
Member
918 posts
Joined: March 2014
Offline
I'm really enjoying the new documentation layout. Great to see work done in this area. On OSX and iOS I'm getting strange chracters for ' apostrophes among others.
Set keyframes on all parameters of the current operator’s active handle
Thanks and keep up the good work,
Andy
User Avatar
Member
466 posts
Joined: Aug. 2014
Offline
I have mixed feelings because I don't like what happened to Python's section (class descriptions). Everything is collapsed by default now. And with everything collapsed it is impossible to use the browser's internal page search (CTRL+F) to search within descriptions of methods and functions. Example: http://www.sidefx.com/docs/houdini15.0/hom/hou/RopNode [sidefx.com]
I've also noticed that pages containing class references are quite slow on mobile devices (scrolling is not fluid).

But it looks like the docs are still being updated so I hope that this will be resolved.

If I may make a suggestion, I think it would be a good idea to move breadcrumbs to the top, fixed bar. This way they would be accessible even when page has been scrolled down.

P.S. I do get those strange characters too (Windows)

P.P.S. A brief list of inherited methods that was always at the top of the page is gone.
User Avatar
Staff
4162 posts
Joined: Sept. 2007
Online
Indeed, I really like that the docs are improving as well! I like how many of the videos from Vimeo are linked within the docs! In addition to the comment about the collapsed Python function descriptions, here are a few other issues I noticed:

- I can't Page Up/Down unless I click, I think the collapsible menu is taking the focus? Is anyone else seeing that; is it something that can even be changed?
- On the Samples page, the animated gifs stop playing after they play through once (Bug #72408)
- I think it'd be nice to have a dark version of the docs, if possible (RFE #72409)

Great job doc team, thank you!
I'm o.d.d.
User Avatar
Member
620 posts
Joined: Nov. 2013
Online
I suggest to keep the “One Sentence” brief description for node/function in reference list page for rapid browse.
User Avatar
Member
185 posts
Joined: March 2008
Offline
Really liking the new docs; finding them more readable and nicely laid out so that's definitely a win

Particularly appreciating the new (or at least new to me) details on packed primitives in rendering and the like; had long wanted an overview of how various systems (e.g. packed primitive, crowd agents) work together so this is really nice to see, and great diagrams as well!

Seems WIP at the moment but finding the new images on the right hand side a bit odd at times as it breaks up the layout and also, in the rendering section, it makes it hard to see the difference between various settings (e.g. in the removing noise section) as both the images are small and you can only see one of them large sized at a time.

This is all to do with the Online Docs; I'm finding that the local help system is not working, and am assuming it is something to do with the update. Before I bug report this was wondering if anyone else was finding this?

OSX, build 15.0.293
User Avatar
Member
101 posts
Joined: Feb. 2015
Offline
I'm getting strange chracters for ' apostrophes among others.

I'm having this problem to. I am on Chrome, windows 7.
https://vimeo.com/user43710534 [vimeo.com]
User Avatar
Member
13 posts
Joined: Oct. 2015
Offline
Hi,
I have the same problem.
I am on Chrome, Win 8.1.
User Avatar
Member
185 posts
Joined: March 2008
Offline
As a side note, migh this be a good time to cull/fill in the pages which have nothing on? The ones which spring to mind are the Character > Finalling section; which I sporadically check in the hopes they've been filled in. If they were remoeved then my hopes wouldn't be dashed
User Avatar
Staff
2493 posts
Joined: Sept. 2007
Offline
If you hit bugs in documentation or elsewhere in the software, please log a bug for them. Thanks!
Chris McSpurren
Senior Quality Assurance Specialist
SideFX
User Avatar
Staff
466 posts
Joined: July 2005
Offline
The weird characters will be fixed, we weren't specifying the encoding on the page.
User Avatar
Member
12461 posts
Joined: July 2005
Offline
ajz3d
Everything is collapsed by default now.

I agree. It would be infinitely better if everything was expanded.

Otherwise it's looking good!
Jason Iversen, Technology Supervisor & FX Pipeline/R+D Lead @ Weta FX
also, http://www.odforce.net [www.odforce.net]
User Avatar
Member
18 posts
Joined: Jan. 2009
Offline
I think the new documentation looks nice but is actually a step backward.

Just compare these pages for example:
http://www.sidefx.com/docs/houdini14.0/expressions/ [sidefx.com]
http://www.sidefx.com/docs/houdini15.0/expressions/ [sidefx.com]

The H14 page is far more helpful.

I'm really glad that the internal H15 help browser still uses the old theme, and I hope it will stay this way!
User Avatar
Member
636 posts
Joined: June 2006
Offline
i think they are still on it, there are still bugs when i go true some topics.

when there is no update make a RFE.
User Avatar
Member
208 posts
Joined: Nov. 2010
Offline
I was just comparing those two pages as well. I decided the new layout meant I didn't have to scroll down so that was helpful.

frederiksnijder
I think the new documentation looks nice but is actually a step backward.

Just compare these pages for example
http//www.sidefx.com/docs/houdini14.0/expressions/
http//www.sidefx.com/docs/houdini15.0/expressions/

The H14 page is far more helpful.
User Avatar
Staff
4162 posts
Joined: Sept. 2007
Online
Could that mech model be made available? Always nice to have good models/rigs to work with
I'm o.d.d.
User Avatar
Member
599 posts
Joined: May 2011
Offline
We just backported a big chunk of changes for the docs, which should be in today's build.
  • Expressions, VEX functions, commands and other lists now show a short snippet of what each call does.
  • We've categorized the VEX functions [sidefx.com].
  • You can now run a central help server, using the new hhelp command. Eg.:hhelp serve
  • UTF8 encoding enforced, so no more funny characters.
  • And more.


    Keep the bugs coming.
Halfdan Ingvarsson
Senior Developer
Side Effects Software Inc
User Avatar
Member
240 posts
Joined: April 2014
Offline
halfdan
Keep the bugs coming.

I love when developers say that. Thank you for all your hard work.
  • Quick Links