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

Redo documentation #291

Merged
merged 3 commits into from
Oct 9, 2024
Merged

Redo documentation #291

merged 3 commits into from
Oct 9, 2024

Conversation

jlewi
Copy link
Owner

@jlewi jlewi commented Oct 9, 2024

Redo the information hierarchy to be more sensible

  • We had a lot of top level documentation (e.g. how to use Anthropic or Ollama) move this one layer deep into How Tos
  • This creates more consistent layout as now all pages are now at least one level deep in the hierarchy rather than being at the first layer

Get rid of some sections

  • Reference there was no useful information in the FAQ so just delete
  • Use-Cases this only contained the email example. This example is no longer particularly relevant now that we are focusing more on operating on software. I also don't think the document does a good job of explaining/showing how to use Foyle. Its more about a specific CLI gctl.

Copy link

netlify bot commented Oct 9, 2024

Deploy Preview for foyle ready!

Name Link
🔨 Latest commit ee0195c
🔍 Latest deploy log https://app.netlify.com/sites/foyle/deploys/6707109fc6974e0008b1b84e
😎 Deploy Preview https://deploy-preview-291--foyle.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jlewi jlewi merged commit 4189fe5 into main Oct 9, 2024
5 checks passed
@jlewi jlewi deleted the jlewi/docs branch October 9, 2024 23:35
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.

1 participant