Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Styling of the docs #229

Open
tasha-m-k opened this issue Jun 5, 2019 · 6 comments
Open

Styling of the docs #229

tasha-m-k opened this issue Jun 5, 2019 · 6 comments
Labels
doc Documentation needs updating enhancement New feature or request

Comments

@tasha-m-k
Copy link
Contributor

Greg checking with Ben Cox,BJ (Design Principle for Z) and Bruce (Zowe OM)

@tasha-m-k tasha-m-k added the doc Documentation needs updating label Jun 5, 2019
@tasha-m-k
Copy link
Contributor Author

Ben suggested using PLEX font if we want it to look IBM-like.

@markcocker
Copy link
Member

markcocker commented Jun 5, 2019

  • it would be nice to have search bar always available. At the moment it is with the top bar that scrolls off the page - perhaps just keep the top bar on-screen all the time.
  • In the nav bar on the left, I find it difficult to differentiate top level headings from level 2 as the background, text size and horizontal position are similar. I also find it odd the nav bar jumps to the top when the window is narrowed, rather than scrolling off to the left. I find the zowe-cli nav bar easier to use https://zowe.github.io/docs-site/latest/user-guide/cli-usingcli.html
  • the "copy to clickboard" icon in the Zowe cli appears when the user mouses over the contents, is within the box boundary, and says has a confirmation "Copied!" message when pressed which are nice features
  • when clicking on a tag, for example getting_started the nav bar seems to go to a pre-canned example
  • In the nav bar Commands - zowe profiles Commands - zowe cics-deploy are both level 1 headings. It may help visual navigation if they were combined into Commands with level 2 headings zowe profiles and zowe cics-deploy with level 3 headings for each command.

@markcocker
Copy link
Member

I tried to update the nav bar in PR #278 but got stuck with yml so asked @cxharris to help review it.

@cxharris
Copy link
Contributor

No further progress with the nav bar - it's possible that there is a bug in the theme. Will carry on investigating when time permits.

@cxharris
Copy link
Contributor

I think we will have to recategorise this issue as an enhancement. Live with the current theme for a while and approach the suggested improvements one at a time.

@markcocker markcocker added the enhancement New feature or request label Jun 21, 2019
@LeighYCompton
Copy link

I don't seem to be able to scroll the index at all. Windows Firefox.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation needs updating enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants