Skip to content

Conversation

kaisalmen
Copy link
Collaborator

@kaisalmen kaisalmen commented Sep 11, 2025

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

This WIP and stays as Draft until we think is ready. @montymxb and @kaisalmen both write and review. The starting point is @montymxb work (partially hand-written, partially LLM generated content).

Completed first reviews/editing round (that alters some changes that are already available on dev branch):

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

Needs rework:

  • advanced-usage directory: The scope needs re-thought and the content needs to be condensed. There is too much redundancy

TODO/questions:

  • guides directory: Do we need the performance guide right now?
  • trouble shooting section from README should be moved to docs/guides/troubleshooting.md and the content from the README should be augmented
  • faq.md: should this just augment the troubleshooting guide and then be merged in the process? There is already an overlap.
  • guides/migration.md: 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

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
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
@kaisalmen kaisalmen force-pushed the kaisalmen/v10-docs-update branch from 441bf59 to 62987df Compare September 11, 2025 20:26
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.

1 participant