Skip to content

Commit

Permalink
Add manual section on modular configurations (tweag#1841)
Browse files Browse the repository at this point in the history
* Add manual section on modular configurations

This commit import the Tweag blog post on the Nickel merge system
(https://www.tweag.io/blog/2023-11-02-nickel-merge-system/) into the
manual almost verbatim (beside a few trivial changes such as "post" ->
"section"). This blog post explores how to use the merging system to
emulate a form of modules, and thus write modular configurations, which
isn't covered currently.

* Apply suggestions from code review

Co-authored-by: Viktor Kleen <[email protected]>

* Apply suggestions from code review

Co-authored-by: Viktor Kleen <[email protected]>

---------

Co-authored-by: Viktor Kleen <[email protected]>
  • Loading branch information
yannham and vkleen authored Mar 11, 2024
1 parent c3e180f commit 71a84b3
Show file tree
Hide file tree
Showing 2 changed files with 427 additions and 8 deletions.
15 changes: 7 additions & 8 deletions doc/manual/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,18 +74,16 @@ website.

## Current state and roadmap

Nickel is currently released in version `1.3`. We expect the core design of the
language to be stable and the language to be useful for real-world applications.
The next steps we plan to work on are:
Nickel is currently released in version `1.4`. The core design of the language
is stable and Nickel is useful for real-world applications. The next steps we
plan to work on are:

- Nix integration: being able to seamlessly use Nickel to write packages and
shells ([nickel-nix](https://github.com/nickel-lang/nickel-nix))
- Custom merge functions (second part of the
[overriding
proposal](https://github.com/tweag/nickel/blob/9fd6e436c0db8f101d4eb26cf97c4993357a7c38/rfcs/001-overriding.md))
- Incremental evaluation: design an incremental evaluation model and a caching
mechanism in order to perform fast re-evaluation upon small changes to a
configuration.
- [Incremental evaluation](https://github.com/tweag/nickel/issues/1589): design
an incremental evaluation model and a caching mechanism in order to perform
fast re-evaluation upon small changes to a configuration.
- Performance improvements

## Content
Expand All @@ -96,6 +94,7 @@ It is composed of the following sections:
1. [Tutorial](./tutorial.md)
1. [Syntax](./syntax.md)
1. [Merging](./merging.md)
1. [Modular configurations](./modular-configurations.md)
1. [Correctness](./correctness.md)
1. [Contracts](./contracts.md)
1. [Typing](./typing.md)
Expand Down
Loading

0 comments on commit 71a84b3

Please sign in to comment.