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.

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

Merged
merged 3 commits into from
May 2, 2023
Merged

Conversation

mansona
Copy link
Member

@mansona mansona commented Feb 1, 2023

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 👍

@void-mAlex
Copy link
Collaborator

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 is great value to open find function in the browser and type in addon and find the document related to that from the main page because it's just there, I personally feel there would be more to lose by moving them than there is to gain from organizational purposes
I hear what you're saying about more documentation, but I thought I would offer this other perspective as well

@NullVoxPopuli
Copy link
Collaborator

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.

@ef4
Copy link
Contributor

ef4 commented Apr 25, 2023

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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

also referenced in

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed 🎉

@mansona mansona merged commit e26de29 into embroider-build:main May 2, 2023
@mansona mansona deleted the docs-folder branch May 2, 2023 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants