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.

Sign up for GitHub

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

Jump to bottom

chore: update docs again #77

Merged
merged 35 commits into from
Sep 25, 2024
Merged

chore: update docs again #77

merged 35 commits into from
Sep 25, 2024

Conversation

lily-de
Copy link
Collaborator

@lily-de lily-de commented Sep 18, 2024 •
edited
Loading

I had to move:

  • docs out of docs/docs
  • mkdocs.yaml into the root directory
  1. Documentation Changes:
    • Generated new reference pages via the script docs/scripts/gen_ref_pages.py.
  2. Assets and Configuration:
    • Modified .gitignore to exclude new documentation-related entries.
    • Added a .nojekyll file for GitHub Pages configuration.
    • Updated mkdocs.yml to incorporate new documentation changes and configurations.
  3. Build & Deployment Configuration:
    • Added a new GitHub Workflow file .github/workflows/deploy_docs.yaml for automating the deployment process of documentation.
    • Updated project root configurations in justfile and pyproject.toml

lily-de and others added 28 commits September 12, 2024 18:05
@lily-de
remove uv installs
0a84b77
@lily-de
add docs with api ref
39b4ad0
@lily-de
update
c7c4376
@lily-de
update docs
8d47e8c
@lily-de
remove lines
ab5e200
@lily-de
remove goose plugins block
8160692
@lily-de
add toolkits docs
09b2485
@lily-de
add tips
8b4ef5f
@lily-de
add cli commands
db2bb74
@lily-de
move mkdocs to dev deps
6005e9f
@lily-de
move building and using toolkits to new section
79a6db3
@lily-de
add section on using toolkits
2039e0c
@lily-de
remove section
55d2f60
@lily-de
update docs
f8237eb
@lily-de
add list command
ec77c33
@lily-de
update
fbfc583
@lily-de
break up toolkits pages
d8828e7
@lily-de
create plugins section
16f6b66
@lily-de
explain processor better
5f000c9
@lily-de
restructure docs folder
ab3b532
@lily-de
add no jekyll file
3a253ce
@lily-de
add site url
ed30881
@lily-de
add reference docs
5a6416f
@lily-de
update
e1d785c
@lily-de
update deps
41d5d6b
@lily-de
add github action for docs
a57df52
@lily-de
only perform if docs are updated
92caff3
@lily-de
Merge branch 'main' into ldelalande/fix-docs-dir-structure
66449db
@lily-de lily-de marked this pull request as ready for review September 18, 2024 15:59
zakiali
zakiali reviewed Sep 20, 2024
View reviewed changes
docs/configuration.md Outdated Show resolved Hide resolved
zakiali
zakiali reviewed Sep 20, 2024
View reviewed changes
docs/providers.md Outdated Show resolved Hide resolved
baxen
baxen approved these changes Sep 25, 2024
View reviewed changes
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!

I think currently the background image rendering is not showing, but we can investigate that potentially in another PR

docs/index.md Outdated Show resolved Hide resolved
docs/reference/index.md Outdated
Comment on lines 10 to 19
- [goose.cli.config](goose/cli/config.md)
- [goose.cli.main](goose/cli/main.md)
- [goose.cli.prompt](goose/cli/prompt/index.md)
- [goose.cli.prompt.completer](goose/cli/prompt/completer.md)
- [goose.cli.prompt.create](goose/cli/prompt/create.md)
- [goose.cli.prompt.goose_prompt_session](goose/cli/prompt/goose_prompt_session.md)
- [goose.cli.prompt.lexer](goose/cli/prompt/lexer.md)
- [goose.cli.prompt.prompt_validator](goose/cli/prompt/prompt_validator.md)
- [goose.cli.prompt.user_input](goose/cli/prompt/user_input.md)
- [goose.cli.session](goose/cli/session.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can exclude the CLI from this ref (and they are rendering blank i think)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When I look at go/goosedocs some of these aren't blank but when I look at the markdown I have saved locally they are blank 😂 I will find out why

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

https://square.github.io/goose/reference/goose/cli/main.html#goose.cli.main.session_clear

docs/reference/index.md Outdated
- [goose.cli.prompt.prompt_validator](goose/cli/prompt/prompt_validator.md)
- [goose.cli.prompt.user_input](goose/cli/prompt/user_input.md)
- [goose.cli.session](goose/cli/session.md)
- [goose.command](goose/command/index.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

ends up blank

docs/reference/index.md Outdated
- [goose.cli.session](goose/cli/session.md)
- [goose.command](goose/command/index.md)
- [goose.command.base](goose/command/base.md)
- [goose.command.file](goose/command/file.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

ends up blank

docs/reference/index.md
- [goose.utils.check_shell_command](goose/utils/check_shell_command.md)
- [goose.utils.diff](goose/utils/diff.md)
- [goose.utils.file_utils](goose/utils/file_utils.md)
- [goose.utils.session_file](goose/utils/session_file.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

ends up blank

codefromthecrypt
codefromthecrypt reviewed Sep 25, 2024
View reviewed changes
Copy link
Collaborator

@codefromthecrypt codefromthecrypt left a comment

Choose a reason for hiding this comment

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

some questions/comments, but nothing blocking

docs/providers.md Outdated Show resolved Hide resolved
docs/cli.md Outdated
@@ -0,0 +1,63 @@
# Goose CLI Commands
Copy link
Collaborator

Choose a reason for hiding this comment

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

I assume this part is generated? and if I make a change to the CLI args, PRs will fail until this is updated, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

nope this one is not generated

@lily-de lily-de merged commit 4704b82 into main Sep 25, 2024
2 checks passed
lifeizhou-ap added a commit that referenced this pull request Sep 25, 2024
@lifeizhou-ap
Merge branch 'main' into lifei/auto-save-sessions
a008211 
* main:
  feat: add shell-completions subcommand (#76)
  chore: update readme! (#96)
  chore: update docs again (#77)
  fix: remove overly general match for long running commands (#87)
lily-de added a commit that referenced this pull request Oct 7, 2024
@lily-de
chore: update docs again (#77)
bb5a426
@lamchau lamchau deleted the ldelalande/fix-docs-dir-structure branch October 24, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codefromthecrypt codefromthecrypt codefromthecrypt left review comments

@baxen baxen baxen approved these changes

@zakiali zakiali zakiali approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lily-de @codefromthecrypt @zakiali @baxen