Miscellaneous fixes, part 6 (plus an “IDE features” section) #23
Conversation
* Don't put a border or background on `code` within a heading * Scale videos to the content area automatically * Left-align `figure` elements and make their captions italic
(TOCs will still hide themselves if there aren't enough headings to justify their presence.)
* In general, use fewer bare references to variables — `locals.foo` instead of merely `foo`, just in case something isn't defined * Allow an API section title override to apply to the page title, too (if appropriate) * Fail more gracefully if sidebar entries aren't present
…and reformat it to make it easier to scan.
confused-Techie
left a comment
confused-Techie
left a comment
There was a problem hiding this comment.
Over-all these docs are absolutely fantastic! I've left just a couple of comments that you may want to look at, but otherwise I'd fully support this being merged, or having my feedback addressed then merged, but in any case awesome work here
|
|
||
| We briefly mentioned how you can [navigate through files by symbol](http://localhost:8082/using-pulsar/movement/#navigating-by-symbols). Those symbols could be a number of things depending on the kind of file: method names, CSS selectors, or Markdown heading names, to list a few examples. | ||
|
|
||
| This functionality is supplied by the built-in {symbols-view} package. Even without an IDE package, Pulsar allows you to navigate by symbols in most languages for the current file. (Since the file is already open, this isn’t hard!) But `symbols-view` also has the ability to jump to a symbol in a _different_ file, but not automatically; it needs something to tell it what those symbols are. A language server can do that very thing! |
There was a problem hiding this comment.
While not needed, maybe a link or comment here about how someone could jump between symbols in the current file in Pulsar, without any installation. Just like above you mention what autocomplete providers are already built in.
EDIT:
Unless these concerns are fully addressed by the commands listed below, which it seems they may be. So if that's the case feel free to ignore this.
There was a problem hiding this comment.
While not needed, maybe a link or comment here about how someone could jump between symbols in the current file in Pulsar, without any installation. Just like above you mention what autocomplete providers are already built in.
They can do that in the Ctrl-R sense (bringing up the palette) but not in the sense that I mean it in this paragraph (moving the cursor to a symbol and then jumping to the symbol with the same name in the current document). That isn't implemented (though it could be!).
docs/ide-features/getting-started.md
Outdated
|
|
||
| The whole point of a language server is to reduce the implementation burden on code editors, since most of the “glue” code is shared across language servers. For that reason, we maintain [a library called `atom-languageclient`](https://github.com/savetheclocktower/atom-languageclient) designed to make it easy to [connect a language server to Pulsar](https://github.com/savetheclocktower/atom-languageclient?tab=readme-ov-file#developing-packages). With practice, you can do it in about a half-hour! | ||
|
|
||
| If you’re not comfortable writing JavaScript, [reach out to us](https://pulsar-edit.dev/community) instead. Creating an IDE package for Pulsar is easier than you think! We can often coach you through the process, or perhaps even write it for you. |
There was a problem hiding this comment.
As long as this isn't seen as a promise I think it's alright, but may want to consider the phrasing before giving anyone false hope
There was a problem hiding this comment.
I'll weaken the promise a bit. :)
| layout: doc.ejs | ||
| --- | ||
|
|
||
| Pretend you’re the inventor of a new language called Zzyzx. |
There was a problem hiding this comment.
Just wanna say, right off the bat, I'm especially loving the tone of this doc
…and fix some URLs that were linking to `localhost`.
|
Thanks for the review! I happened to catch a couple places where I was linking to |
In one of my previous PRs I accidentally introduced a link to an “IDE features” section of the docs — something I've been meaning to write for a while, but hadn't gotten around to. Well, this is as good of an excuse as any, so here's that section in full.
It's not perfect, and it risks becoming an advertisement for my own packages. But I think it's quite helpful to new users and may even contain some information that's new to core team members. Where possible, I've illustrated these features with screenshots and/or screencasts.
Other than that, the changes are rather small — a broken link fixed, some style tweaks, et cetera.