block / goose

Goose is a developer agent that operates from your command line to help you do the boring stuff.
https://block.github.io/goose/
Apache License 2.0
109 stars 17 forks source link

docs: update deploy workflow #124

Closed lily-de closed 2 weeks ago

lily-de commented 2 weeks ago

What was wrong

  1. The goose home page was not pretty because of some symlink issues between the README and docs/index.md
  2. The deploy_docs workflow was borked / not installing deps

Solution

  1. Removed the symlink between the readme and the homepage file (docs/index.md) and just copied over the full readme into index.md and updated some asset paths as needed. Also removed video because I could not get it to play on the home page (it still works in the readme)
  2. Moved to using uv to manage doc deployment

thanks @lamchau @lukealvoeiro and @damienrj for working with me on this!

lamchau commented 2 weeks ago

@lily-de should we close out #120 in favor of this? looks like warnings/errors don't show up in ci anymore

lily-de commented 2 weeks ago

Added a follow up ticket to better sync the readme and docs homepage: linear (for internal tracking); github issue