-
Notifications
You must be signed in to change notification settings - Fork 142
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.
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
Move docs into a docs folder #1348
Conversation
in my own opinion this would make then way less accessible to people, I've gotten to click through other .md docs because I just opened the repo and they were there to click on |
there are also a bunch of places linking to the docs where they are now. -- since we don't have the ability to redirect on GitHub, we'd break all those links. |
Discussed this and decided to replace the existing files each with a message "moved to /docs/..." but all future docs can get created in docs. We also think we should try to maintain an index in the README that points to the various docs to aid discoverability. |
@@ -27,7 +27,7 @@ This repo implements a new three-stage build system for Ember apps: | |||
and 3 improves our ability to innovate and experiment with taking the best | |||
parts of wider JS ecosystem tooling. | |||
|
|||
You can read more about the motivation and key ideas in the [intro to the SPEC](SPEC.md). | |||
You can read more about the motivation and key ideas in the [intro to the SPEC](docs/spec.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also referenced in
embroider/packages/macros/README.md
Line 9 in 3a232cc
The [Embroider package spec](../../SPEC.md) proposes fixing this by making Ember addons much more static. But they will still need the ability to change themselves in certain ways at app compilation time. Hence this package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed 🎉
Considering that we're likely going to be writing a lot more documentation over the coming months, I thought it was about time that we move all the random docs hanging around into a nice and neat docs folder 👍