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 the docs out from the README.md #209

Merged
merged 1 commit into from
May 3, 2023

Conversation

bocharsky-bw
Copy link
Contributor

@weaverryan idea. Is docs/index.md a good place?

@weaverryan
Copy link
Member

Hey! Thanks for getting this rolling :). Really, what we need to do is:

A) Move this to a doc/index.rst file
B) Create a .symfony.bundle.yaml file
C) Ping Javier to add this to https://symfony.com/bundles

e.g. like https://github.com/symfony/ux/tree/2.x/src/Autocomplete :)

@bocharsky-bw
Copy link
Contributor Author

@weaverryan changes are done! Should this PR be merged first and then we need to ping Javier?

Copy link
Member

@weaverryan weaverryan left a comment

Choose a reason for hiding this comment

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

Looks good! Just one tweak. And yes, we'll merge that I'll ping Javier

README.md Outdated

Ok, have fun!
[1]: https://symfony.com/doc/current/frontend.html
[2]: https://github.com/symfony/webpack-encore-bundle/blob/main/doc/index.rst
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[2]: https://github.com/symfony/webpack-encore-bundle/blob/main/doc/index.rst
[2]: https://symfony.com/bundles/WebpackEncoreBundle/current/index.html

That doesn't exist yet, but that's where we should take them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was thinking about fixing it after we will have a working URL, but let's do it in advance :)

@weaverryan
Copy link
Member

Thanks Victor!

@weaverryan weaverryan merged commit 101b9b2 into symfony:main May 3, 2023
11 checks passed
@bocharsky-bw bocharsky-bw deleted the unload-readme branch May 3, 2023 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants