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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about how spotlight handles requests #1084

Merged
merged 1 commit into from Dec 4, 2017

Conversation

Projects
None yet
2 participants
@pcraig3
Copy link
Contributor

pcraig3 commented Dec 1, 2017

The genesis of this is that I've spent a bunch of time tracing
through what to me is a labyrinthine application structure.

I can intellectually appreciate that spotlight has a cool,
avant-garde application design or something but, on a practical
level, the thing is hella complicated and all the super smart
people who designed it have left.

Hopefully this is more helpful than the very high level overview
that currently exists in the /docs folder.

//

Notes for @rossjones:

  • it's probably more helpful reading this as an interpreted markdown file 馃憠 like here
  • there are a lot of links to the code, but that's because when I wrote it without links it felt like it was super confusing
    • I've linked to the current commit, which I think is fine as I don't expect the code to change massively
    • not averse to removing some links but I don't want to remove them all
  • this is a bit more general purpose than what I originally intended to write but it's still probably worth having
  • also the ending is quite abrupt. it feels like I got to the root of the issue, but maybe it trails off to quickly
Add documentation about how spotlight handles requests
The genesis of this is that I've spent a bunch of time tracing
through what to me is a labyrinthine application structure.

I can intellectually appreciate that spotlight has a cool,
avant-garde application design or something but, on a practical
level, the thing is hella complicated and all the super smart
people who designed it have left.

Hopefully this is more helpful than the very high level overview
that currently exists in the /docs folder.

@rossjones rossjones merged commit e6c2975 into master Dec 4, 2017

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@rossjones rossjones deleted the write-about-requests branch Dec 4, 2017

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