Editor integration: inline Markdown source mode and a VS Code extension (plan, awaiting decisions)

Open
  • Is something wrong?
#170 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
csharp, markdown, typescript, vscode
Domain
developer-experience

Research direction

Start by reading the proposed ADR 0034 and the listed dependency, issue #161, for the fwmd CLI. The plan spans a document service, editor mode, and VS Code extension, but 15 owner decisions are pending and the ADR is not yet in the repository. Work can be scoped once those decisions are resolved; the issue gives no settled completion criteria.

Written by the indexing model from the issue text.

Description

Plan drafted 2026-11-06, with a proposed ADR 0034 that is not yet in the repo. The shape:

  • one UI-free document service in SIL.TextEditing.Markdown (analyse → findings, canonical text, paragraph-to-source map);
  • the fwmd CLI first (#161);
  • an inline source mode as a second RichTextField with a Markdown language service, which needs that language service to work on several paragraphs;
  • a VS Code extension: a .NET language server (native AOT), a thin TypeScript client and a TextMate grammar.

About 11–16 weeks over 7 phases. Owner decisions E-1 to E-15 are pending: source surface, toggle scope, undo (a narrow ADR 0003 amendment), leaving with errors, records, LSP shape, JSON-RPC, distribution, project context, language id, preview, location, publishing, npm packages, CLI shape. The ADR lands once they are decided.

Dominant language
C#
Stars
0
Forks
0
Avg merge
1h 43m
Merged PRs (30d)
43

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sillsdev/SIL.TextEditing

All issues in sillsdev/SIL.TextEditing

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.