Skip to content

Commit

Permalink
fix: more docs cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
lbennett-stacki committed Aug 17, 2024
1 parent d53c663 commit d377270
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 42 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We're just getting started. Any help is welcome.

## Getting help

Ask a question in GitHub discussions, issues or discord or email [support@useenvy.cloud](mailto:support@useenvy.cloud)
Ask a question in GitHub [discussions](https://github.com/envyhq/envy/discussions), [issues](https://github.com/envyhq/envy/issues) or [discord](https://discord.gg/tRmdFySx) or email [support@useenvy.cloud](mailto:support@useenvy.cloud)

## Bug reports

Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,15 @@ A language for configuration.

[Envy FigJam discovery board](https://www.figma.com/file/YLWiYaLvchfUlrbmr4P0M2/NV-Discovery?type=whiteboard&node-id=0%3A1&t=7aag2YKaHTLDS4lW-1)

Ask a question in GitHub
[discussions](https://github.com/envyhq/envy/discussions),
[issues](https://github.com/envyhq/envy/issues),
[discord](https://discord.gg/tRmdFySx) or email [support@useenvy.cloud](mailto:support@useenvy.cloud)

## Packages

- Lexer - [Source](./packages/lexer/src/lib.rs)
- Parser - [README](./packages/parser/README.md) [Source](./packages/parser/src/lib.rs)
- Parser - [README](./lang/packages/parser/README.md) [Source](./packages/parser/src/lib.rs)
- Resolvers
- Variable Resolver - [Source](./packages/resolvers/var/src/lib.rs)
- Provider Resolver - [Source](./packages/resolvers/provider/lib.rs)
Expand Down Expand Up @@ -48,13 +53,17 @@ A language for configuration.

## Extensions

- VSCode - [README](./extensions/vscode/README.md) [Grammar](./extensions/vscode/syntaxes/nv.tmLanguage.json) [Language Server Client Source](./extensions/vscode/language-server-client/extension.ts)
- VSCode
- [README](./extensions/vscode/README.md)
- [Grammar](./extensions/vscode/syntaxes/nv.tmLanguage.json)
- [Language Server Client Source](./extensions/vscode/language-server-client/extension.ts)
- treesitter - [README](./extensions/tree-sitter/README.md) [Grammar](./extensions/tree-sitter/grammar.js)
- github-linguist - **TODO**

## Examples

A lot of packages have an examples/ directory to show simple usage of the packages API.
A lot of packages have an examples/ directory to show
simple usage of the packages API.

## LSP

Expand Down
2 changes: 1 addition & 1 deletion clients/typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@nv/typescript",
"name": "@envy/typescript",
"version": "1.0.0",
"description": "Envy TypeScript client",
"main": "dist/index.js",
Expand Down
6 changes: 1 addition & 5 deletions cloud/db/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Envy Database
# Envy Cloud Database

## Release

Expand All @@ -7,7 +7,3 @@ Run migrations:
- `atlas migrate diff` (`just diff`)
- `atlas migrate lint` (`just lint`)
- `atlas schema apply` (`just migrate`)

```
```
26 changes: 4 additions & 22 deletions cloud/ui/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Envy UI
# Envy Cloud UI

Client web app for Envy (NV)
Client web app for Envy Cloud

## Getting Started

Expand All @@ -16,23 +16,5 @@ pnpm dev
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Open [http://localhost:3000](http://localhost:3000)
with your browser to see the result.
25 changes: 15 additions & 10 deletions lang/packages/parser/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# nv compiler
# Envy compiler

## Variable times

![NV Variable Times](./docs/assets/images/variable-times.png)
![Envy Variable Times](./docs/assets/images/variable-times.png)

## Compilation flow

![NV Compilation Flow](./docs/assets/images/compilation-flow.png)
![Envy Compilation Flow](./docs/assets/images/compilation-flow.png)

> Character stream -> grapheme stream -> Token stream -> Syntax tree -> Client code
Expand All @@ -20,7 +20,13 @@

### Grapheme stream

A grapheme is the smallest unit in language. A char to your average programming language is a single unicode character code point. The difference is that a grapheme is a single character as understood by humans. For example, an emoji like πŸ’†πŸ½β€β™€ is made of multiple unicode characters but understood as one. This is also true for `\r\n` for example that is 2 unicode characters that represent a single newline.
A grapheme is the smallest unit in language.
A char to your average programming language is a single unicode character code point.
The difference is that a grapheme is a single character as understood by humans.
For example, an emoji like πŸ’†πŸ½β€β™€ is made of multiple
unicode characters but understood as one.
This is also true for `\r\n` for example that is 2
unicode characters that represent a single newline.

> var πŸ”‘: str
Expand Down Expand Up @@ -109,11 +115,11 @@ SourceFile {

### Client code

![NV Source Code Generation](./docs/assets/images/source-code-generation.png)
![Envy Source Code Generation](./docs/assets/images/source-code-generation.png)

`nv` aims to compile into multiple target languages to make integration easy and to allow nv to be opinionated (and useful) throughout the development lifecycle.
Envy aims to compile into multiple target languages to make integration easy and to allow envy to be opinionated (and useful) throughout the development lifecycle.

Currently you don't see any references to "providers", here is your first introduction. Still WIP, providers allow developers to specify the data sources of various config values. These could be pulled from a central nv config service, or it could be a third party or external secret management system like AWS Secrets Manager or HasiCorp Vault.
Currently you don't see any references to "providers", here is your first introduction. Still WIP, providers allow developers to specify the data sources of various config values. These could be pulled from a central envy config service, or it could be a third party or external secret management system like AWS Secrets Manager or HasiCorp Vault.

By generating client code, we can also handle the fetching of these values at runtime, which is crucial in particular for private values. A private value provided at any point before the runtime is likely easily recoverable by at least a dev team, which makes it recoverable by bad actors.

Expand Down Expand Up @@ -179,16 +185,15 @@ match provider_name {

##### Rust blocking

For use in syncronous programs, a blocking/non-async/non-tokio version of nv rust client.
For use in syncronous programs,
a blocking/non-async/non-tokio version of envy rust client.

```rs
// TBC
```

#### Python

> :warning: need confirmation on this, was generated by gpt4, would also like a mojo flavour. I'll refresh my python soon.
```py
import asyncio

Expand Down

0 comments on commit d377270

Please sign in to comment.