diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 6 | ||||
-rw-r--r-- | docs/dev/architecture.md | 13 |
2 files changed, 5 insertions, 14 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 104dd703d..d81c2f70d 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -12,7 +12,11 @@ should be enough to get you started! | |||
12 | To learn more about how rust-analyzer works, see | 12 | To learn more about how rust-analyzer works, see |
13 | [./architecture.md](./architecture.md) document. | 13 | [./architecture.md](./architecture.md) document. |
14 | 14 | ||
15 | Various organizational and process issues are discussed here. | 15 | We also publish rustdoc docs to pages: |
16 | |||
17 | https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html | ||
18 | |||
19 | Various organizational and process issues are discussed in this document. | ||
16 | 20 | ||
17 | # Getting in Touch | 21 | # Getting in Touch |
18 | 22 | ||
diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index f990d5bf0..890b18fcd 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md | |||
@@ -130,19 +130,6 @@ APIs in this crate are IDE centric: they take text offsets as input and produce | |||
130 | offsets and strings as output. This works on top of rich code model powered by | 130 | offsets and strings as output. This works on top of rich code model powered by |
131 | `hir`. | 131 | `hir`. |
132 | 132 | ||
133 | ### `crates/ra_ide_api_light` | ||
134 | |||
135 | All IDE features which can be implemented if you only have access to a single | ||
136 | file. `ra_ide_api_light` could be used to enhance editing of Rust code without | ||
137 | the need to fiddle with build-systems, file synchronization and such. | ||
138 | |||
139 | In a sense, `ra_ide_api_light` is just a bunch of pure functions which take a | ||
140 | syntax tree as input. | ||
141 | |||
142 | The tests for `ra_ide_api_light` are `#[cfg(test)] mod tests` unit-tests spread | ||
143 | throughout its modules. | ||
144 | |||
145 | |||
146 | ### `crates/ra_lsp_server` | 133 | ### `crates/ra_lsp_server` |
147 | 134 | ||
148 | An LSP implementation which wraps `ra_ide_api` into a langauge server protocol. | 135 | An LSP implementation which wraps `ra_ide_api` into a langauge server protocol. |