Skip to content

Update and re-organise documentation#572

Merged
alcarney merged 15 commits into
openlawlibrary:mainfrom
alcarney:refactor-docs
Jul 20, 2025
Merged

Update and re-organise documentation#572
alcarney merged 15 commits into
openlawlibrary:mainfrom
alcarney:refactor-docs

Conversation

@alcarney

@alcarney alcarney commented Jul 19, 2025

Copy link
Copy Markdown
Collaborator

Description (e.g. "Related to ...", etc.)

The existing user guide is an odd mismatch of information that is also, in places, inaccurate (e.g. #569).

This PR breaks the user guide up into separate more focused articles which (hopefully!) is easier to navigate, while simultaneously updating the information in line with v2. Rather than wait for perfect, some of these articles will be not written/incomplete but we should be able to pick these off over time

Closes #569

Code review checklist (for code reviewer to complete)

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
  • Title summarizes what is changing
  • Commit messages are meaningful (see this for details)
  • Tests have been included and/or updated, as appropriate
  • Docstrings have been included and/or updated, as appropriate
  • Standalone docs have been updated accordingly

Automated linters

You can run the lints that are run on CI locally with:

uv run --all-extras poe lint

@alcarney alcarney marked this pull request as ready for review July 19, 2025 21:44
@alcarney alcarney requested a review from tombh July 19, 2025 21:44
@tombh

tombh commented Jul 20, 2025

Copy link
Copy Markdown
Collaborator

Nice. I checked out https://pygls--572.org.readthedocs.build/en/572/ too and it looks good.

@alcarney

Copy link
Copy Markdown
Collaborator Author

Thanks!

@alcarney alcarney merged commit a204d0d into openlawlibrary:main Jul 20, 2025
18 checks passed
@alcarney alcarney deleted the refactor-docs branch July 20, 2025 17:07
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.

send_notification not found in v2.0

2 participants