Design Suggestions Database Schema and API for Documentation Chunks

[4e6]

Summary

We need better docs in the IDE. To do that, the language server will generate and store the HTML documentation strings in the suggestions database. This task is to design the database schema allowing to store documentation chunks, and a new API to send the documentation chunks as a part of suggestions database updates.

Value

The language server is able to provide the documentation chunks for the IDE.

Specification

• Extend the suggestions database schema to store documentation chunks. Documentation chunks need to be ordered. For a chunk, we should get a list of previous chunks and the chunks after this one.
  An example of an index. It's a good idea to keep it normalized. The final list can be assembled in an SQL query (SQLite supports recursive queries).

  SUGGESTION_ID	SUGGESTIONS_BEFORE	SUGGESTIONS_AFTER
  000001	ID1	ID2

  An example of a doc table.

  SUGGESTION_ID	HTML_FRAGMENT
  000001	...

• Extend the suggestion updates API to support the documentation chunks.

Acceptance Criteria & Test Cases

• There is an SQL schema for storing documentation chunks.
• The language server suggestion updates API supports documentation chunks.