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

Reorganise table of contents #9

Merged
merged 2 commits into from
Mar 26, 2025
Merged

Conversation

itowlson
Copy link
Contributor

This attempts to address the issues noted in #4 (comment).

  • I've reorganised the applications section to writing->structure->building->running (line) testing->observing->troubleshooting (line) config
  • I've made triggers their own section, and each trigger is now top-level. The cron trigger entry is a bit weird @flynnduism, it seems to cite the /redis-trigger and /triggers page - what was your intent here?
  • I've reorganised the API guides section and reverted the name changes (e.g. I have a very strong preference for "Making HTTP Requests" over "HTTP Interface").
  • Moved the reference to a reference section
  • Moved a bunch of internals and nerd stuff into a "project" section. I don't love this name but found things like data layout and contributing guides and plugin authoring stuff without a good home... it's all kind of stuff for people who are developing Spin-related stuff rather than building Spin apps. Better ideas welcome
  • Moved user-facing plugins and templates stuff into a Tools group (again not the ideal name but they definitely didn't belong in the applications group). Restored the "managing" name to distinguish them from authoring.

I am not sure if I've mucked up the styles or something, but locally it now looks like this for me:

image

which seems a lot more spread out (and the section headers a lot smaller) than I remember in the preview from #4 - but I may be misremembering!

@itowlson itowlson requested a review from flynnduism March 20, 2025 03:11
@vdice
Copy link
Contributor

vdice commented Mar 26, 2025

@itowlson if you'd like, a PR deployment preview will be available if you rebase on main -- but you'd also have to re-create the PR on origin for it to work.

@itowlson
Copy link
Contributor Author

@vdice I've compared how it looks vs how other previews look and concluded that it was my memory that was messed up rather than my PR.

@itowlson itowlson merged commit e648d27 into spinframework:main Mar 26, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants