[Discussion] Proposed changes to the CSS

[wmarshall484]

I am proposing an update to the CSS of the website. I felt the current styling of the documentation could be improved:

• Navigation: I want to see where I am in the docs as I navigate.
• Placement of the table of contents: when the TOC is really long, it has a tendency to push the content down the page further than is desirable.
• Search: I want to be able to search by title or keywords in a doc page.
• General look and feel.

Proposed changes: http://wmarshall484.github.io/documentation-theme-jekyll/mydoc/home.html

Since the update touches many files, I'm holding off on a merge request for now. I think it goes a long way with the site's general look and feel. What are your thoughts?

[kathyssaunders]

Thank you for working on this, Will. I do like the new navigation. A few questions:

• Can we have a link to the Javadoc in the navigation?
• What will the Edit me button do. Right now, for me, I get a page not found error, but what is the intent? It would be great if there was an easy way to edit or create pull requests for doc changes.
• The Github Repo button goes to the quarks project. Should it go to the quarks.documentation project? Maybe a pull down where you can choose which project you want?
• We can't use Apache Quarks Incubating yet, so can you please update that? The vote passed to accept us, but until we are set up there with code, etc., we can't reference Apache. Activites are going on now to set those things up.
• I like the search box!
• I kind of like the old banner color at http://quarks-edge.github.io/quarks.documentation//. It matches our github.io page.

Thank you so much for working on this to make the docs easier to navigate!

[wmarshall484]

Glad you like the changes! The navbar helps a lot.

Can we have a link to the Javadoc in the navigation?

Yup. Can you post a link to the Javadoc? I couldn't find it.

What will the Edit me button do.

The edit button will send you to the markdown sourcecode in the github repository. If you have a github account, there will be a button to edit it.

Right now, for me, I get a page not found error

That will be fixed once it merges.

The Github Repo button goes to the quarks project. Should it go to the quarks.documentation project? Maybe a pull down where you can choose which project you want?

We can do a pulldown, although I think it's cleaner as a button.

We can't use Apache Quarks Incubating yet, so can you please update that?

Ah, gotcha. I'll update that.

I like the search box!

+1

I kind of like the old banner color

Should be able to update that as well.

[home4slc]

Nice job @wmarshall484 - it looks cleaner and lighter.

[Alex-Cook4]

I like it a lot! I agree with Kathy on the Javadoc. Here is the link: https://quarks-edge.github.io/quarks/docs/javadoc/index.html

Personally, I'm not a big fan of the icons next to the titles.

Overall, +1

[wmarshall484]

Personally, I'm not a big fan of the icons next to the titles.

Okay, those anchors should be easy to remove.

[kathyssaunders]

Yup. Can you post a link to the Javadoc? I couldn't find it.
https://quarks-edge.github.io/quarks/docs/javadoc/index.html

The Github Repo button goes to the quarks project. Should it go to the quarks.documentation project? Maybe a pull down where you can choose which project you want?

We can do a pulldown, although I think it's cleaner as a button.

How about pointing to https://github.com/quarks-edge?. I think we should do that or the quarks.documentation project as this is the documentation page.

[wmarshall484]

I like the idea of it pointing to https://github.com/quarks-edge. We have a number of github repositories, so maybe the top-level project would work better.

[wmarshall484]

I made the changes based on this feedback and merged the pull request. Github seems to be a bit slow refreshing the generated website, unfortunately.

[chanskw]

+1 Looks Awesome...

[Alex-Cook4]

@wmarshall484 I think you found the perfect balance for icon use. Looks great!

[Alex-Cook4]

When the table of contents has a lot of things form the current page, you can no longer see the site directory without scrolling down. I think we should allow more space for the navigation on the side:

[Alex-Cook4]

@wmarshall484 URLs seem to have changed possibly from the CSS changes? I've opened #60.