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: usage with NestJS #115

Open
fahad19 opened this issue Jul 25, 2023 · 8 comments
Open

Docs: usage with NestJS #115

fahad19 opened this issue Jul 25, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@fahad19
Copy link
Member

fahad19 commented Jul 25, 2023

Recently, we added a guide for using Featurevisor SDK with Express.js applications:

What's desired

Would be great to have similar documentation for NestJS too: https://nestjs.com/

Where to add docs?

  • Create a new file in docs/frameworks/nestjs.md
  • Add it to sidebar navigation in docs/sidebarNavigation.json under "Framework guides"
@fahad19 fahad19 added help wanted Extra attention is needed documentation Improvements or additions to documentation labels Jul 25, 2023
@akshayamadhuri
Copy link

@fahad19 i would like to work on this issue

@fahad19
Copy link
Member Author

fahad19 commented Aug 5, 2023

@akshayamadhuri: sure please go ahead.

@akshayamadhuri
Copy link

@fahad19 how about adding copy options for the code snippets

@fahad19
Copy link
Member Author

fahad19 commented Aug 6, 2023

@akshayamadhuri: it would be a nice addition indeed, but the documentation website's code sits in a private repository. and the documentation content are all available as markdown files in this repository.

so we cannot tackle it at this moment conveniently.

@akshayamadhuri
Copy link

akshayamadhuri commented Aug 7, 2023

@fahad19 do we need to create a working repository for nestjs

@fahad19
Copy link
Member Author

fahad19 commented Aug 7, 2023

@akshayamadhuri: that will give us confidence that it works as documented/expected.

Express.js example repo can be found here for reference: https://github.com/featurevisor/featurevisor-example-expressjs

@akshayamadhuri
Copy link

@fahad19 can i raise PR without working repository

@fahad19
Copy link
Member Author

fahad19 commented Aug 7, 2023

@akshayamadhuri: of course. we can tackle things one by one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants