Skip to content

Instantly share code, notes, and snippets.

@rlefevre

rlefevre/package.blue.md Secret

Last active February 16, 2020 21:03
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rlefevre/804ebb70ab902a4929ade8e81278e351 to your computer and use it in GitHub Desktop.
Save rlefevre/804ebb70ab902a4929ade8e81278e351 to your computer and use it in GitHub Desktop.
Download ZIP
package.elm-lang.org update changelog
Raw
package.blue.md

Changelog

New features

  • Design update & refining
    Note: this includes the following visual refining:
    • Blue and Dark themes
    • Simplify packages description versions links
    • Simplify footer and keep it to page bottom
    • Shorten navigation "Browse Source" to "Source" and "Module Docs" to "Modules"
    • Use visual alignment for inputs
  • Use a responsive design for small screen widths
    Movitation: offer the significant number of mobile and tiled window manager users a better experience
    Based on: https://discourse.elm-lang.org/t/poll-your-use-of-package-elm-lang-org-on-mobile-or-tablet/4813
  • Rank packages based on average use per year in around 4300 Elm Open Source applications
    Motivation: offer users a fair ranking based on actual packages use to help them choose one.
    Based on an improved version of: https://discourse.elm-lang.org/t/most-popular-packages-in-open-source-applications/4207
    Elm conferences talks ranking is still used for packages with equal or no popularity.
  • Search query parameter in URL
    Motivation: allow to go back to search results after checking a package doc during a search
    Notes:
    • On Search page, cilck logo to reset
    • On Package page, click the package version to reset
  • Support for firefox keyword bookmark (right click on search input) or chrome search engine setting
    Motivation: fast access in browser for searching packages from anywhere
  • Sticky scrollable right navigation
    Motivation: improve modules navigation
  • Add About section with install command, release date, license and dependencies
    Motivation: Based on open issues and feedback from https://github.com/dmy/elm-package-info.
    More precisely:
    Install command: #27, #288, https://discourse.elm-lang.org/t/the-governance-of-elm-docs-and-smaller-tools/4571 Note: there might have been some arguments against it by the past, but I was not able to find the source (I searched most of old google groups) and can't think of any, so tell me if you know.
    Release date: meticulous authors put detailed release notes in GitHub Releases page. In addition to giving information about the release date, this links directly to this release page. This link has been suggested by Ian Mackenzie. For an example see: https://github.com/ianmackenzie/elm-geometry/releases
    License: Allow companies developers to detect licensing issues as early as possible
    Dependencies: Make easier for developpers to reduce their dependencies and chose ones from trusted authors.
    Inspired by Richard talk part about dependencies: https://youtu.be/RN2_NchjrJQ?t=1391
  • Click a function/type/operator to go to its source
    The link to documentation is now the whole padding on the left of the markdown comment.
    Right-clicking (or long pressing on mobile) the symbol to get the link also still works.
  • Add warning for latest packages version not compatible with Elm 0.19.1
    Motivation: prevent users trying to use old packages
  • Add support for /packages/author URL
    Motivation: see packages from trusted authors (including elm and elm-explorations)

Advanced users experimental features

  • Use "elm-search" when query contains "->" and query submitted (Enter pressed)
    Motivation:
    • offer advanced users a shortcut to elm-search
    • help onboarding of haskell (hoogle) users
  • Space in modules search box displays all symbols
    Motivation: provide an index of a package functions without changing the current design and without disturbing users that don't want it.

Bug fixes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment