Proposed sitemap

[savetheclocktower]

I mentioned before that I think we could consolidate some sections and differentiate them a bit better. Here's what I've got so far, with changes explained in italics. Let me know if this seems OK:

• Getting started

  • What is Pulsar?
  • Installing Pulsar
  • Dependencies for some community packages

• Using Pulsar (article titles rewritten to remove redundant references to Pulsar)

  • Basics
  • Movement
  • Packages
  • Selections
  • Editing and deleting text

• Core packages and features (article titles rewritten to remove redundant references to Pulsar)

  • Find and replace
  • Snippets
  • Autocomplete
  • Version control
  • GitHub
  • Spell check
  • Previews
  • Folding
  • Panes
  • Grammars

• Customize Customizing Pulsar (renamed for consistency)

  • Configuring with CSON
  • Creating your own snippets
  • Tweaking styles
  • Customizing keybindings
  • Configuring global settings
  • Configuring language-specific settings
  • Customizing language recognition
  • Controlling where data is stored
  • The init file

• Package guides (I think this should be a series of articles underneath another heading, most likely Developing for Pulsar)

• The infrastructure of Pulsar (formerly “Behind Pulsar”)

  • Configuration API
  • Keymaps in depth
  • Scoped settings, scopes, and scope descriptors
  • Serialization
  • Developing Node modules
  • Interacting with other packages via services

• Developing for Pulsar

  • Summary (Should be removed unless we have meaningful content to put on this page)
  • Creating a community package
  • Package example: Word count
  • Package example: Modifying text
  • Package example: Active editor info
  • Creating a community theme
  • Package example: Syntax theme (once this guide exists)
  • Creating a language grammar (overview)
  • Creating a language grammar (Modern Tree-sitter)
  • Creating a language grammar (legacy Tree-sitter) (or omit this altogether)
  • Creating a language grammar (TextMate)
  • (We don’t need the “converting a grammar from TextMate” docs)
  • Publishing your package
  • Maintaing your package
  • Using icons
  • Writing specs
  • Handling URIs
  • Contributing to official Pulsar packages (moved to the “Contributing to Pulsar” section)

• Troubleshooting Pulsar (renamed from “Debugging Pulsar”)

  • Having trouble? (moved from “FAQ” section)
  • Common issues (moved from “FAQ” section)
  • Update to the latest version
  • Using safe mode
  • Clearing saved state
  • Resetting to factory defaults
  • Checking for linked packages
  • Checking for incompatible packages
  • Checking Pulsar and package configuration
  • Checking your keybindings
  • Diagnosing font rendering issues (still needed?)
  • Checking for errors in developer tools
  • Locating crash logs
  • Diagnosing startup performance
  • Profiling startup performance
  • Diagnosing runtime performance
  • Checking your build tools
  • Checking if your GPU is causing the problem

• FAQ (contents moved to the ”Troubleshooting Pulsar” section)

• Hacking pulsar Contributing to Pulsar (to contrast it with “Customizing Pulsar”)

  • Building Pulsar
  • Using PPM
  • Hacking on the core
  • Tools of the trade
  • Contributing to official Pulsar packages (moved from the “Developing for Pulsar” section)

• The Pulsar organization (formerly “Maintaining Pulsar”) — (actually, we should also ask ourselves whether this needs to be included at all)

  • Tooling

[confused-Techie]

Overall totally love these changes, and think they make total sense.

Although on the few items being proposed for removal (textmate conversion and legacy Tree-sitter) I'd argue it's still important to keep those around up until their functionality is actually removed. But of course we can add big warnings to not to anything new with this information, but keep it around for understanding and troubleshooting legacy content.

But otherwise this looks totally fantastic! The only idea I've had otherwise is instead of "The infrastructure of Pulsar" being "Pulsar in-depth" but that's naming only and not super important

[savetheclocktower]

But otherwise this looks totally fantastic! The only idea I've had otherwise is instead of "The infrastructure of Pulsar" being "Pulsar in-depth" but that's naming only and not super important

I don't love either of these names, to be honest, so I'll keep brainstorming. I want to make sure people know how that section is different from others.

[confused-Techie]

Yeah that's valid, but otherwise this does sound awesome to me. So I'll hold off fixing all the links until we get slugs finalized

[savetheclocktower]

OK, gonna open another PR soon once I move everything around. I'll keep thinking about a better name for that one section