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

/r/java launch #88

Closed
18 tasks done
nedtwigg opened this issue Jan 9, 2024 · 4 comments
Closed
18 tasks done

/r/java launch #88

nedtwigg opened this issue Jan 9, 2024 · 4 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@nedtwigg
Copy link
Member

nedtwigg commented Jan 9, 2024

  • make / redirect to /jvm (cloudflare pages)
  • body text and examples should lose their largest responsive size
  • inline code literals are too circular
    • image
  • mdx links should render as links
  • mdx should render ul as bullets
  • "fastest and most precise" "record and specify" "behavior of your system..." should each link to https://thecontextwindow.ai/assertions-are-just-bad-snapshots probably with hover:underline
  • landing page nav to the right of the headers should be "pop-out" to http://localhost:3000/jvm/get-started#quickstart, etc
    • ideally same tab, back button takes you to the nav entry you left from
    • okay to open a new tab if that is hard
    • seems like it isn't hard /r/java launch #88 (comment)
  • octocat (preferably in the same style of button frame) to the right of
    • image
  • bottom of landing page
  • NED: "selfie is literal" shows .toBe_TODO() but not toBe() and //selfieonce, not clear if toBe is understood by user when they get to lensable (fixed by better #literal section)
  • NED: modes should discuss the CI usecase in a sentence or two fa84583
  • NED: landing page "literal" should learn some lessons from the quickstart aa3e37b
  • NED: bottom of get-started should link to advanced
  • NED: bottom of advanced should link to GitHub
  • NED: fix github README links, add contributing, specific call for help, link to "assertions are just bad snapshots"
  • NED: write advanced docs
  • update binary snapshot on homepage
  • mobile pass

post to

Let's see what GitHub does

  • github does this
    • and this
  • interesting
@nedtwigg nedtwigg added the docs Improvements or additions to documentation label Jan 11, 2024
@nedtwigg nedtwigg mentioned this issue Jan 11, 2024
10 tasks
@nedtwigg
Copy link
Member Author

nedtwigg commented Jan 11, 2024

  • We have a comment above about pop-outs and returning to the same scroll position. At the bottom of the landing page we have links to the kdoc, and they are actually very annoying because you lose scroll position. Looks like this could fix it.

@nedtwigg
Copy link
Member Author

nedtwigg commented Jan 11, 2024

  • As I use this, I'm getting blue=new_link purple=visited_link vibes. Is it easy to have the hover be blue for new links and purple for visited?
image

@WebsByTodd
Copy link
Collaborator

We have a comment above about pop-outs and returning to the same scroll position. At the bottom of the landing page we have links to the kdoc, and they are actually very annoying because you lose scroll position. Looks like this could fix it.

We chatted about this, but I want to document it. Scroll restoration isn't working during local development and I think maybe it's related to this issue. But it's moot because we are deploying the site statically and when the site is deployed statically the browser will handle scroll restoration the way we would expect it to. It just doesn't work in dev mode.

@WebsByTodd
Copy link
Collaborator

How about a docs 404 page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants