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

📖 DOC: Install Run Deploy #208

Closed

Conversation

Saif-Shines
Copy link
Contributor

@Saif-Shines Saif-Shines commented Feb 15, 2024

The instructions are to install, run, and deploy the AI gateway in different channels.

  • Show the channels to run and deploy the AI gateway on the README.md
  • Clarify untold instructions like installing NodeJS or Importing the repository to Netlify or Replit using Hyperlinks.
  • Update the code snippets to show syntax highlighting
  • Introduce a new file install-run-deploy.md that has same purpose as installation-deployments.md to keep them both until the content is well articulated. Once ready, we could ensure only one exists.
  • Ensure all the instructions from existing intallation-deployments.md stay. Improve them.
  • Instructions for Replit
  • Instructions for Netlify
  • Instructions for Vercel
  • Instructions for Local — bunx and npx
  • Instructions for others (work in progress)
  • A seperate "deploy-on-replit.md" file will act as landing page on Replit instead of the current README.md as landing page

Copy link
Collaborator

@vrushankportkey vrushankportkey left a comment

Choose a reason for hiding this comment

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

@Saif-Shines
Copy link
Contributor Author

Saif-Shines commented Feb 15, 2024

We will keep both the files. It is just a convenience to edit one independently without disturbing the original.

Updated the description properly

@Saif-Shines Saif-Shines marked this pull request as ready for review March 26, 2024 15:24
@Saif-Shines Saif-Shines force-pushed the docs/install-run-deploy branch from 1986866 to 22d63c8 Compare April 10, 2024 04:56
README.md Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we standardise the section headings?

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 tried to address these comments and raise another PR #297

Reason: This PR has become old and is not rebased with the main branch. Instead of working with merge conflicts, raised an seperate PR.

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.

2 participants