Skip to content

Documentation Structure Overhaul #54

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Conversation

dkattan
Copy link
Contributor

@dkattan dkattan commented Apr 7, 2025

Documentation Structure Overhaul

This PR implements a new documentation structure for docs.immy.bot that better organizes both existing and new content. The changes include:

  1. Implementing the proposed documentation structure in VitePress
  2. Migrating existing content to the new structure
  3. Creating missing core feature documentation

Changes Made

  • Updated VitePress configuration with new navigation structure
  • Created comprehensive documentation for core features:
    • Deployments
    • Maintenance Tasks
    • Maintenance Sessions
    • User Affinity
    • Targeting
    • Computer Onboarding
    • Agent Installation
  • Reorganized existing content into a more logical structure
  • Updated homepage to reflect new documentation organization

Link to Devin run

https://app.devin.ai/sessions/b25d453c9b6b4fc997d0ac6441b5b072

Requested by

[email protected]

Copy link

Original prompt from [email protected]:

I would like to overhaul the Immybot documentation. 

The goal is to make the following updates: 
- Update the existing docs.immy.bot to be more useful to new users and to cover the functionality that currently exists in the immybot repo. 
- Every page in the application will have a page level help section (like we currently have on the deployments page) with some basic page information and a link to the updated docs.immy.bot where the user can find more information on that feature, how to use it, common issues, best practices, etc. 
- Some pages should also have form-field level help sections (also check the new deployments page for an example) where it makes sense. 

For now, I just want to:
- brainstorm on the best way to accomplish this based on what exists in the immybot repo without losing any of the context already in docs.immy.bot.
- discuss what the new documentation structure would like
- Do not make any code changes until we come up with a plan that I agree on. 


Copy link

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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