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: update deploy workflow #124

Merged
merged 25 commits into from
Oct 8, 2024
Merged

docs: update deploy workflow #124

merged 25 commits into from
Oct 8, 2024

Conversation

lily-de
Copy link
Collaborator

@lily-de lily-de commented Oct 7, 2024

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
Copy link
Collaborator

lamchau commented Oct 7, 2024

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@lily-de lily-de changed the title chore: update deploy workflow docs: update deploy workflow Oct 8, 2024
@lily-de lily-de marked this pull request as ready for review October 8, 2024 15:52
docs/scripts/gen_ref_pages.py Outdated Show resolved Hide resolved
docs/scripts/gen_ref_pages.py Outdated Show resolved Hide resolved
docs/scripts/gen_ref_pages.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@baxen baxen left a comment

Choose a reason for hiding this comment

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

LGTM!

Can be a separate PR but i think in the future we should try to use https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
to include the readme literal so we don't risk them growing out of sync

@lily-de
Copy link
Collaborator Author

lily-de commented Oct 8, 2024

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

@lily-de lily-de merged commit 5029b19 into main Oct 8, 2024
4 checks passed
lukealvoeiro added a commit that referenced this pull request Oct 9, 2024
* main: (41 commits)
  chore: Add goose providers list command (#116)
  docs: working ollama for desktop (#125)
  docs: format and clean up warnings/errors (#120)
  docs: update deploy workflow (#124)
  feat: Implement a goose run command (#121)
  feat: saved api_key to keychain for user (#104)
  docs: add callout plugin (#119)
  chore: add a page to docs for Goose application examples (#117)
  fix: exit the goose and show the error message when provider environment variable is not set (#103)
  fix: Update OpenAI pricing per https://openai.com/api/pricing/ (#110)
  fix: update developer tool prompts to use plan task status to match allowable statuses update_plan tool call (#107)
  fix: removed the panel in the output so that the user won't have unnecessary pane borders in the copied content (#109)
  docs: update links to exchange to the new location (#108)
  chore: setup workspace for exchange (#105)
  fix: resolve uvx when using a git client or IDE (#98)
  ci: add include-markdown for mkdocs (#100)
  chore: fix broken badge on readme (#102)
  feat: add global optional user goosehints file (#73)
  docs: update docs (#99)
  chore(release): release 0.9.3 (#97)
  ...
ahau-square added a commit that referenced this pull request Oct 10, 2024
* main:
  feat: add groq provider (#134)
  feat: add a deep thinking reasoner model (o1-preview/mini) (#68)
  fix: use concrete SessionNotifier (#135)
  feat: add guards to session management (#101)
  fix: Set default model configuration for the Google provider. (#131)
  test: convert Google Gemini tests to VCR (#118)
  chore: Add goose providers list command (#116)
  docs: working ollama for desktop (#125)
  docs: format and clean up warnings/errors (#120)
  docs: update deploy workflow (#124)
  feat: Implement a goose run command (#121)
@lamchau lamchau deleted the ldelalande/fix-deploy-docs branch October 24, 2024 11:45
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.

4 participants