GithubHelp home page GithubHelp logo

Comments (3)

zk avatar zk commented on May 12, 2024

Nah, you did it correctly. The shitty thing is that there are a couple of options that I can see right now, none of which gets us to the goal of having super-readable urls:

  1. munging it slightly (clojuredocs.org/org.thnetos|client/my-ns/my-var)
  2. Completely (clojuredocs.org/v/123/org-thnetos-client/my-ns/my-var)
  3. encoding (clojuredocs.org/org.thnetos%2Fclient/my-ns/my-var, which should but dosen't work with the current stack).

I have to look into this a bit more, but the issue is that some of the allowed characters in lib / ns / var names are going to collide with url reserved characters, so we'd have to map each of those collisions to new chars, or encode. Encoding would solve this problem but affects readability and mentally generating CD urls on the fly.

Ultimately I think I'm just putting off really putting some thought into it in favor of cleaning up the codebase, but we should definitely talk about it on tues.

from clojuredocs.

zk avatar zk commented on May 12, 2024

Turns out this will be fixed as part of the versioning stuff. As discussed today, we went the munging route:

  • Added a url_friendly_name column to the libraries and functions tables
  • On import (and migration), names are munged: ? -> _q, / -> \space, \space -> _
  • Result is stored in the url_friendly_name column

I'm still on the fence about the 'encoding' scheme, any suggestions?

from clojuredocs.

zk avatar zk commented on May 12, 2024

commit 0b51e2b

from clojuredocs.

Related Issues (20)

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.