Conversation
|
@ampinsk This looks great! I'm going to take a note of moving man pages to under In the meantime, I've wanted to find a solution to generate sidebar links in |
mislav
force-pushed
the
add-landing-page-v2
branch
from
4fdb08e to
7a17a54
Compare
|
Updated the body with some more detailed todos! Getting to a place where I need some help with some of these remaining tasks. |
Decided to not do white on black because it's way more jarring to scan on the page
These rules would make us unable to display any unordered list or `<h6>` to manual pages in the future, even if they're unrelated to the "SEE ALSO" section. We now strip "SEE ALSO" and the footer when we regenerate man pages into the `gh-pages` branch.
As long as we have a sticky header, we can't safely link to an anchor in the middle of the page (such as in Examples) because the resulting scroll position will have the target heading be obscured by the sticky header element. In github.com we solve this using JavaScript, but the solution is not easily portable and doesn't always work really well with back-forward navigation. There are content or CSS workarounds offered on the internet, but they usually require content changes or sacrificing accessibility. The easiest way to allow linking to an anchor on the page is to avoid having a sticky header.
|
I've nested man pages under How to update man pages after future releases of gh:
The last step can potentially be automated via release automation, so we don't have to always remember to do it manually, but to pull that switch I'd first wait for the site to stop being in flux.
I've noticed that too, right now I've disabled the sticky header to fix that. My rationale is in the commit message
This one is tricky 😕 Jekyll has built-in support for syntax highlighting code from different programming languages, but terminal prompt and command output is not any specific language, so we can't really use the Jekyll feature. I think we are forced to resort to manual syntax highlighting using |
sophshep
left a comment
sophshep
left a comment
There was a problem hiding this comment.
- How can the landing page and man pages be more connected? Right now they feel very separate since the landing page has the full github nav. Personally, I don't think it needs this and it can be the collapsed version, like on https://education.github.com/ There may be some other ways to bring the marketing styles to the manual too.
- The content strategy of these feels unnecessarily separated out to me. Do you need the "examples in use" in the sidebar if those examples are in context with the commands?
- The hierarchy in the sidebar could be more clear. Maybe like:
Installation
Commands
gh
help
issue
create
list
status
view
pr
checkout
create
list
status
- When there's room, it would be nice for the left sidebar to stay fixed
- Synopsis description is repeated twice on the top of pages
|
Hey @sophshep thank you for the feedback, I'm going to address this in a following PR! Wanted to merge this so the current man pages don't look totally borked. |
Also this was already fixed! ✨ |
* Add CohereModel * Format * Update pyproject.toml * Update src/strands/models/cohere.py * Revert cusom cli, keep only compat layer * Format and fixes
5 participants
Opening this for visibility! This is targeting @gladwearefriends's landing page work in #235, so that should be merged first
To Dos
Man page generation
/manual/directory (@mislav I may need some help from you here!)Visual bugs and details
ghin sidenav should be OverviewExample content
Future nice to haves
Here's what it looks like right now:
cc @trosage since you're wrapping up Catherine's work!
Closes #77