Git Product home page Git Product logo

deku-documentation's Introduction

Deku documentation

Hi πŸ‘‹

This is where the deku documentation lives. It's all written in Deku! Check it out here.

deku-documentation's People

Contributors

mikesol avatar alaendle avatar neppord avatar toastal avatar charlestaylor7 avatar olaberglund avatar

Stargazers

Serhii Khoma srghma.github.io/how-life-was-created avatar  avatar Kento Okura avatar Hadj H. avatar Tristan de Cacqueray avatar  avatar KlarkC avatar

Watchers

 avatar

deku-documentation's Issues

Out of place example in Core/Collections/GroupsOfGroups

To me it seems that this paragraph has no connection to the associated example on the page.

[ text_ "In this example, we see the use of "
, D.code__ "useHot"
, text_ " instead of "
, D.code__ "useState"
, text_
". To understand why, think about the contract with the state variable "
, D.code__ "badness"
, text_
". The UI responds to it by creating a new section and then this section starts listening to "
, D.code__ "badness"
, text_ ". But by the time it starts listening to "
, D.code__ "badness"
, text_
", the click event has already fired, so the inner listener does not evaluate the statement "
, D.code__ "(_ > Worse)"
, text_ ". To provide the nested "
, D.code__ "flatten"
, text_ " with the most recent event, we use "
, D.code__ "useHot"
, text_ "."
]

https://purescript-deku.netlify.app/core-concepts/collections#groups-of-groups

Question: Can the "Hi" in this example be already rendered into HTML via SSR since it doesn't depend on an Event?

While I played around with SSR I wondered if static text could be included in the rendered HTML - I used text_, but I think it's basically the same as in the example:

myApp s = D.div_
[ D.h4__ "Hi!"
, D.div__ "Here's some HTML for a Deku app:"
, htmlCode s
]

The reason I ask is that the content of elements affects the arrangement/location of the elements - so if static/constant text could be included in the HTML this would reduce changes during hydration.

Dark mode: headings in right hand nav are initially black

Hi, I'm just reading through the documentation in dark mode and I noticed a styling issue.

The right hand "On this page" nav shows headings, with sub-items indented under them. In light mode, these are black, and light blue when viewing. In dark mode, I'm guessing they're supposed to be white and light blue when viewing; but instead they start off as black, but once they're highlighted in blue as viewed, then they revert to white.

image image

At first I thought that there were different styles for read vs. unread headings, and there was an oversight with the dark mode unread style, but I can't see a visible distinction in light mode so I'm guessing it's a subtler bug of some sort.

App intermittently freezes on iOS, locking up browser

I've been reading the documentation on Chrome on iOS, and eventually the app gets into what I'm guessing is an infinite loop: nothing is responsive (though pages are still scrollable), and even when I press to refresh, the browser hangs forever with a loading bar, without unloading the page. I have to close the tab and reopen the page in a new tab.

I haven't been able to find a specific trigger for this. It happens intermittently, but seems to happen eventuallyβ€”after reading through a couple of pages or so.

Warn users that inline CSS conflicts with CSP best practices

A Content Security Policy should be implemented in every opportunity for better site security. For what should be obvious reasons, style-src: unsafe-inline is never recommended. However, the documentation has a number of instance of showing off inline CSS, style_, etc. which will likely require unsafe-inline. This could be seen as "out of scope" for the project, but when enticing users into features, they should be reminded of the any negative trade-offs when present. Technically you can use nonces, but this wildly complicates a build when the simpler option is to just use external CSS.

Typo: a should be b

Screenshot_20240324-102735_Kiwi Browser

type Poll a = forall b. Event (a -> b) -> Event a
type SampleOnRight a =
  Event a -> (forall b. Event (a -> b) -> Event a)

Should be

type Poll a = forall b. Event (a -> b) -> Event b
type SampleOnRight a =
  Event a -> (forall b. Event (a -> b) -> Event b)

Consider using typographically-correct symbols in the docs

This change would aid in readability and also just look nicer.

  • ... β†’ … / …
  • ' β†’ β€˜ + ’ / &lsquo + ’
  • " β†’ β€œ + ” / &ldquo + ”

Given there is text in what looks like French possibly with accented characters, there is a precedence to not be limited to ANSI characters. Elements like <q> may also be appropriate.

(I’d push for ∷, β†’, βˆ€, but don’t wanna push my luck πŸ˜›)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.