Update documentation #427
Update documentation #427
Conversation
|
@tombh are you able to enable pr builds for readthedocs? |
|
I don't yet. I message David about it. |
|
David said that it should be enabled now. |
|
Hmm, it does not appear to be working... I'd expect to see a readthedocs item to appear in the list of CI checks and it be linked to a build of the docs generated from this PR 🤔 |
|
Ah 😬 Okay, I've let David know. |
|
You should have an invite to join the readthedocs.io account. |
|
I don't see anything wrong in the config... though the docs suggest that resync-ing the webhook might fix it - something that I don't have permission (in GitHub) todo. |
|
The "Pull requests" toggle wasn't set: So I set it. Does that fix it? |
Yes! Thank you 😄
You can now click the |
|
Would love to see more example of implementations. For example I am looking for how to implement "find reference". I find Jedi's example: https://github.com/pappasam/jedi-language-server/blob/9df0ab5c3481c4e637a8cc1dc3bb5e7afb11c960/jedi_language_server/server.py#L414C1-L428C44 What's the plan or guideline around adding new examples? I may be able to contribute back an example or two later. I think the library is awesome but it's hard to get started with it. Often, I need to look at other libraries source code instead of the docs. |
|
Have you found our example servers? You can find an example of find references here. Though I admit we don't currently have any prose to explain what is going on.
I'd like to convert all of the tests here to end to end tests like these, where each test is backed by a corresponding example server. #440 was the first pass at this and I'm currently working on an example server for the various document formatting methods.
If you can, that would be awesome :)
I agree, hopefully, slowly but surely we can turn that around :) |
|
@alcarney Thanks, I did see the example but somehow missed the I think one thing that I struggle with is that I don't know how to map the server protocol to something that I can see in an IDE (VSCode). I understand This example servers is amazing btw, it has the backbone of everything I needed. Thanks again!
For sure, let me know if there is anything I can help, like reviewing the documentation or testing it. |
|
https://github.com/microsoft/vscode-extension-samples/tree/main/completions-sample came across this and I find this is quite helpful. |
This uses the `myst_parser` extension to pull in various markdown files from the root of the project to build a section that includes the changelog and more.
Nothing new just yet, just making what already exists more prominant
|
@tombh would you be ok with merging this PR as is? It's not going to be perfect, but I think this is in a place now where we can start adding to it incrementally |
alcarney
force-pushed
the
update-docs
branch
2 times, most recently
from
dc94bc3
to
7956754
Compare
Rather than duplicate the hello world example in the documentation, import the code directly so that it's always up to date
|
Sure! I had a look at https://pygls--427.org.readthedocs.build/en/427/ and it looks great! |
|
Thanks! |
As highlighted in #424, our tutorial is a bit out of date and could do with a refresh.
This PR takes the opportunity to update the documentation as a whole, re-organizing it so that it's hopefully easier to navigate. I'm also porting some of the examples that are buried in our issues so that they are easier to find.
I'm using the Diátaxis documentation framework as a guide
TODO
Code review checklist (for code reviewer to complete)