Running guider error #5
Comments
|
Yep. I can't see this repository, so it's hard to tell what exactly goes wrong. |
|
Would you like access? |
|
Without it I can't really debug this. |
|
I'm working on access. :) |
|
I think the guider doesn't like my guides.json nesting. [
{
"title" : "Requirements",
"items" : [
{
"title" : "Install IDE",
"items" : [
{
"title" : "Eclipse",
"items" : [
{
"name" : "install_eclipse_mac",
"url" : "guides/basics/install_ide/install_ide_eclipse/eclipse_install_mac",
"title" : "Mac Install",
"description" : "Install Eclipse on a Mac."
}
]
},
{
"title" : "IntelliJ IDEA",
"items" : [
{
"name" : "install_idea",
"url" : "guides/basics/install_ide/install_ide_idea",
"title" : "IntelliJ IDEA Install",
"description" : "Install IntelliJ IDEA."
}
]
}
]
},
{
"title" : "Install GWT IDE Plugin for",
"items" : [
{
"name" : "install_gwt_plugin_eclipse",
"url" : "guides/basics/create_gwt_project/create_gwt_standard_eclipse",
"title" : "Eclipse",
"description" : "How to install GWT Eclipse plugin."
},
{
"name" : "install_gwt_plugin_idea",
"url" : "guides/basics/install_gwt_plugin/gwt_plugin_install_idea",
"title" : "IntelliJ IDEA",
"description" : "How to install GWT IntelliJ IDEA plugin."
}
]
},
{
"title" : "Create a GWT Project in",
"items" : [
{
"name" : "create_gwt_project_eclipse",
"url" : "guides/basics/install_gwt_plugin/gwt_plugin_install_eclipse",
"title" : "Eclipse",
"description" : "Create a GWT project on Eclipse."
},
{
"name" : "create_gwt_project_idea",
"url" : "guides/basics/create_gwt_project/create_gwt_standard_project_idea",
"title" : "IntelliJ IDEA",
"description" : "Create a GWT project on IntelliJ IDEA."
}
]
}
]
},
{
"title" : "Getting Started",
"items" : [
{
"title" : "3.x",
"items" : [
{
"name" : "getting_started_3",
"url" : "guides/getting_started/getting_started_3",
"title" : "General 3.x Configuration",
"description" : "Getting started with GXT 3.x."
},
{
"name" : "getting_started_3_eclipse_standard",
"url" : "guides/getting_started/getting_started_3/eclipse_standard",
"title" : "Eclipse Standard Src Folders",
"description" : "Getting started with Eclipse standard source folders."
},
{
"name" : "getting_started_3_idea_standard",
"url" : "guides/getting_started/getting_started_3/idea_standard",
"title" : "IDEA Standard Src Folder",
"description" : "Getting started with IDEA standard source folders."
}
]
}, {
"title" : "2.x",
"items" : [
{
"name" : "getting_started_2",
"url" : "guides/getting_started/getting_started_2",
"title" : "General 2.x Configuration",
"description" : "Getting started with EXT GWT 2.x."
}
]
}
]
}
] |
|
Oh yeah. I skipped implementing this as none of the guides in Sencha docs use the nesting feature. |
|
So maybe you could just ditch the nesting for now. As I'm not really certain what's really the future of how we'll structure the docs. And also IMHO the nesting isn't really that well implemented in JSDuck either. I have started to think towards throwing away the whole guides.json config file entirely - just reading in all the guides inside the guides directory and having some index guide (or really just a plain HTML file) that just links to the rest of the guides. And then some of those pages could link to subpages, so the whole index doesn't need to be managed in one big file. |
|
It's slightly a pain to edit the guides.json, although I like that it turns on and off what I want to stick in the published version. The reason I mention that, is I have some half baked docs and wouldn't want them get published yet. Although I wouldn't mind not having the guides.json, b/c it's slightly tedious. Maybe a guide.json or meta data at the top of in the guide markdown would be easier. Google code wiki uses meta data at the top of the wiki that doesn't get rendered, but turns on off what the features of the document are. |
|
I could get rid of the nesting for now, but I think it has some value to the end user drilling documentation. But I see your point about the nesting. JSDuck nesting rendering in the left menu, expands all the categories which is nice. If they were closed by default, I think getting lost in the docs would be much easier. One thing I do like about the nesting is it allows for shorter verbiage in the titles of the guides for me. |
|
Would it take quite a bit of work to fix the nesting? |
|
Not really I guess. But at least it will have to wait till another day. It's too late today for me already :) |
|
Sounds good. I'll take what I can get for the moment so I can get things moving forward and maybe we can take a second look down the road if needed. |
|
The support for nesting in guides.json is now implemented in v0.0.3. But much of the behavior of guider itself has changed. |
|
Good job on all the issue enhancements! :) |
Running guider on my docs errors. Not sure what's going on yet.
My docs:
https://github.com/branflake2267/gxt/tree/docs/docs (not sure you can see this)
The text was updated successfully, but these errors were encountered: