Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

arch: improve archived documents #3

Merged
merged 5 commits into from
Feb 9, 2020
Merged

arch: improve archived documents #3

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7f30dc
Move features doc to archive dir
DerekNonGeneric Feb 3, 2020
5e49fc7
Improve Archives section
DerekNonGeneric Feb 3, 2020
3c47d57
arch: match description on README and archived document
DerekNonGeneric Feb 5, 2020
ced0ff2
Add the plan to the archive
DerekNonGeneric Feb 7, 2020
966f026
Add missing text; remove unnecessary detail
GeoffreyBooth Feb 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Work includes:

## Archives

As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of [features](./doc/features.md), which guided the [plan for the implementation](./doc/plan-for-new-modules-implementation.md).
- **[`features.md`](./doc/archive/features.md)**: As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, [use cases](./doc/use-cases.md) were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the [plan for the implementation](./doc/plan-for-new-modules-implementation.md).
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're going to make a bullet for each archived file, then we need a bullet for the plan-for-new-modules-implementation.md file too. It's also archived, and both files should be in doc/archive.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see my FIXME comments in the latest commit.


## Members

Expand Down
9 changes: 7 additions & 2 deletions doc/features.md → doc/archive/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Features
| This document has been archived. It is now read-only. |
|---|

| Date archived | Reason | Description |
|---|---|---|
| 12 February 2020 | Cause of confusion | As part of creating the ECMAScript Modules implementation for Node.js 12.0.0, use cases were brainstormed, which led to a list of features. This feature list, which previously existed as a section in this repo's root README, informed what became the plan for the implementation. |

> The below list of features was written for the new ECMAScript modules implementation that was created for Node 12.0.0. These features informed what became the [plan](./plan-for-new-modules-implementation.md) for that implementation.
# Features

Based on [these use cases](./doc/use-cases.md) ([#55](https://github.com/nodejs/modules/issues/55)), our implementation aims to support the following features (subject to change):

Expand Down