Skip to content

Documentation update#956

Merged
kaisalmen merged 7 commits into
devfrom
kaisalmen/v10-docs-update
Sep 18, 2025
Merged

Documentation update#956
kaisalmen merged 7 commits into
devfrom
kaisalmen/v10-docs-update

Conversation

@kaisalmen
Copy link
Copy Markdown
Collaborator

@kaisalmen kaisalmen commented Sep 11, 2025

This PR should include all changes to the documentation required for the monaco-languageclient v10 release.

@montymxb and @kaisalmen both write and review. The starting point is @montymxb work (partially hand-written, partially LLM generated content).

TODO list:

  • Complete contend in main docs directory
    • Completed index.md, installation.md, introduction.md
    • migration guide: We need to have a migration guide from v9 to v10. Especially explain how to treat the removal of monaco-editor-wrapper and how to use the three config types also in @typefox/monaco-editor-react. That should be done by @kaisalmen
    • faq.md: should this just augment the troubleshooting guide and then be merged in the process? There is already an overlap.
      • Removed for now. May be brought back in the future if need is identified.
  • Complete contend in main guides directory
    • Merge basic-usage and guides: index.md, getting-started.md, configuration.md, examples.md
    • Do we need the performance guide right now? It removed for now. It may be added at a later point
  • advanced-usage directory: The scope needs re-thought and the content needs to be condensed. There is too much redundancy
    • It was removed. Advanced topics may be added in the future, when the need is identified
  • trouble shooting section from README should be moved to docs/guides/troubleshooting.md and the content from the README should be augmented
    • Done
  • Update monaco-languageclient package README
  • Update monaco-languageclient CHANGELOG
  • Update @typefox/monaco-editor-react package README
  • Update @typefox/monaco-editor-react CHANGELOG
  • Update examples CHANGELOG
  • Update repository description
  • Additional content/changes/alignments:
    • Contains all diagrams to be used in the upcoming blog post.
    • The bare example has been moved to the json client folder and been renamed to json_classic.ts. The main json example uses extended mode and both examples now make use of EditorApp.

@kaisalmen kaisalmen requested a review from montymxb September 11, 2025 16:23
@kaisalmen kaisalmen requested a review from CGNonofr as a code owner September 11, 2025 16:23
@kaisalmen kaisalmen marked this pull request as draft September 11, 2025 16:23
@kaisalmen kaisalmen force-pushed the kaisalmen/v10-docs-update branch 2 times, most recently from 2c7a175 to f8dac63 Compare September 15, 2025 14:14
@aglinxinyuan
Copy link
Copy Markdown

Sorry, clicked on approve by mistake.

@kaisalmen kaisalmen marked this pull request as ready for review September 17, 2025 07:15
@kaisalmen
Copy link
Copy Markdown
Collaborator Author

For the record: I updated the description and added check boxes for closed & open points.

@kaisalmen kaisalmen changed the title WIP: Documentation update Documentation update Sep 17, 2025
@kaisalmen kaisalmen force-pushed the kaisalmen/v10-docs-update branch from 8977c84 to b6d81eb Compare September 17, 2025 10:19
kaisalmen and others added 5 commits September 17, 2025 16:10
Contains all diagrams to be used in blog posts
Bare example is now json_classic example

Completed Review:
- main directory (index.md, installation.md, introduction.md)
- basic-usage directory (index.md, getting-started.md, configuration.md, examples.md)

Partially reviewed:

- advanced-usage directory

TODO review / edit:

- guides directory
- faq.md

Create:

- guides/migration.md
- grammar corrections & general improvements
- removes advanced usage docs (saved elsewhere for later)
- merges basic usage into guides
- updates index.md in guides to reflect merge
- consolidates troubleshooting info

Signed-off-by: Benjamin Friedman Wilson <benjamin.wilson@typefox.io>
- Update diagrams
- Drop faq for now
- Update links
@kaisalmen kaisalmen force-pushed the kaisalmen/v10-docs-update branch from b6d81eb to 79cf9b8 Compare September 17, 2025 14:38
…r-react package README

- Aligned other content accordingly
- Linked migration guide from main README
@kaisalmen kaisalmen force-pushed the kaisalmen/v10-docs-update branch from 79cf9b8 to 22cdb6c Compare September 17, 2025 15:43
@kaisalmen kaisalmen merged commit d63fd1a into dev Sep 18, 2025
1 check passed
@kaisalmen kaisalmen deleted the kaisalmen/v10-docs-update branch September 18, 2025 08:42
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.

3 participants