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

docs in own files, added plugins & integrations #312

Merged
merged 1 commit into from
Oct 17, 2020

Conversation

PabloSzx
Copy link
Member

@PabloSzx PabloSzx commented Oct 8, 2020

  • Added Table of Contents (meanwhile the website docs is pending, and because I think the README is getting too big and hard to navigate)
  • Plugins section as talked in File upload plugin #126

Preview in https://github.com/PabloSzx/mercurius/tree/readme-patch#table-of-contents & https://github.com/PabloSzx/mercurius/tree/readme-patch#plugins

Preview in https://github.com/PabloSzx/mercurius/tree/readme-patch#mercurius

@mcollina
Copy link
Collaborator

mcollina commented Oct 9, 2020

@AlexNiallMalin you might need to do something about this in: #305

@mcollina
Copy link
Collaborator

mcollina commented Oct 9, 2020

I think it's best if we split the readme into multiple md files inside the docs folder instead. It's too big it's unmanageable.

@AlexNiallMalin AlexNiallMalin mentioned this pull request Oct 9, 2020
@AlexNiallMalin
Copy link

@mcollina Yes I agree this would be the best way to go! I can sort this in the process of expanding on #305

@PabloSzx PabloSzx changed the title TOC & plugins in README docs in own files, added plugins & integrations Oct 16, 2020
Copy link
Collaborator

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm from me

are you planning any more work on this PR?

@PabloSzx
Copy link
Member Author

PabloSzx commented Oct 16, 2020

I don't know what is your opinion on mentioning test utilities around mercurius.

For example, I made mercurius-integration-testing to ease integration testing.

are you planning any more work on this PR?

I think there might be space for a brief introduction before every More info in the main README

@PabloSzx
Copy link
Member Author

Oh, in the previous commit I forgot to add Integrations in the main README, I just added it

@PabloSzx PabloSzx marked this pull request as ready for review October 16, 2020 15:37
Copy link
Collaborator

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mcollina mcollina merged commit df9f408 into mercurius-js:master Oct 17, 2020
@mcollina
Copy link
Collaborator

Would you like to move it to the org? Then we can mention it as official.

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

3 participants