enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-11-22 22:10:15 +03:00
Code Issues Projects Releases Wiki Activity
34009e1111
enso/docs
History
Dmitry Bushev 34009e1111
Add the Runtime Cache Design Docs (#764) 
* doc: add runtime cache design

* Apply suggestions from code review

doc: review edits

Co-authored-by: Ara Adkins <iamrecursion@users.noreply.github.com>

* doc: fix formatting

* doc: benchmark result

* doc: add sections

* doc: update cache backend

* doc: remove redundant eviction section

* doc: rename eviction strategy section

* doc: merge two eviction sections

Co-authored-by: Ara Adkins <iamrecursion@users.noreply.github.com>
2020-05-20 16:34:23 +03:00
..
distribution Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00
language-server Miscellaneous documentation fixes (#770) 2020-05-20 12:21:52 +01:00
polyglot Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00
rfcs Miscellaneous documentation fixes (#770) 2020-05-20 12:21:52 +01:00
runtime Add the Runtime Cache Design Docs (#764) 2020-05-20 16:34:23 +03:00
semantics Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00
style-guide Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00
syntax Fix a broken link in the syntax docs 2020-05-18 14:03:27 +01:00
types Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00
CODE_OF_CONDUCT.md Miscellaneous documentation fixes (#770) 2020-05-20 12:21:52 +01:00
CONTRIBUTING.md Miscellaneous documentation fixes (#770) 2020-05-20 12:21:52 +01:00
enso-philosophy.md Update the frontmatter in enso-philosophy.md 2020-05-20 09:00:25 +01:00
README.md Miscellaneous documentation fixes (#770) 2020-05-20 12:21:52 +01:00
SECURITY.md Restructure the developer documentation (#751) 2020-05-15 11:41:26 +01:00

README.md

layout title category tags order
docs-index Enso Developer Documentation summary
summary
readme
0

Enso Developer Documentation

This folder contains the documentation for the implementation of the Enso programming language. The documentation is broken up by subject, within the below-listed categories, and each subject combines information about the design, specification, and implementation of the feature to which it pertains.

We provide a number of useful resources for getting a quick understanding of the Enso project:

  • The Enso Philosophy: Information on the design philosophy behind Enso, and why we build things in the way we do.
  • Contributing Guidelines: Information for people wanting to contribute to Enso (in many different ways).
  • Community Code of Conduct: The code of conduct for members of our community, developers and users alike.
  • Security Guidelines: Security guidelines for the Enso project, including supported versions and our vulnerability reporting process.

It is broken up into categories as follows:

  • Distribution: Information on how we distribute Enso to our users, and how Enso packages themselves work.
  • Language Server: Information on the Enso language server, its protocol, and how it integrates with the runtime.
  • Polyglot: Information on Enso's polyglot functionality, and how it is integrated into the surface Enso language.
  • RFCs: RFCs for Enso's development and evolution.
  • Runtime: Specification and documentation of the way that the Enso runtime is designed and implemented.
  • Semantics: A specification of Enso's semantics.
  • Style Guides: Style guides for the code written as part of the Enso project.
  • Syntax: A specification of Enso's syntax.
  • Types: A specification of Enso's type system and type theory.