feed-generator icon indicating copy to clipboard operation
feed-generator copied to clipboard

Better docs for deployment process and removing bad deployments

Open andrewpking opened this issue 1 year ago • 2 comments

Better Docs for deployment process

  • A lot of users in the issues page are complaining of issues in their deployment.
  • Most of these have to due to confusion about what FEEDGEN_HOSTNAME env variable represents
  • Do I need my own private server to publish feeds, or can I resolve them to be published to bluesky's servers? This is not made clear in the docs.

Docs do not include steps for unpublishing a feed

  • I was able to figure it out by reading the code
  • It might help to have docs for people who are less experienced with using typescript
  • Its just one command

Update docs for new command line process for deploying

  • The docs are out of date and ask people to edit the code to provide variables
  • Now the variables are collected by the command line interface
  • Update the docs to match the current process.

andrewpking avatar Nov 18 '24 23:11 andrewpking

I found better docs here, but it should be included in the readme.

andrewpking avatar Nov 18 '24 23:11 andrewpking

Also would love documentation on the creation of /.well-known/did.json or automation of this process. I was so confused by this as someone who has never used web3, I had to read closed issues to understand what format it was expecting for this.

andrewpking avatar Nov 24 '24 18:11 andrewpking