Skip to content

Conversation

@kmcginnes
Copy link
Collaborator

@kmcginnes kmcginnes commented Sep 10, 2025

Description

This is the first stage of documentation overhaul. The goal was to only move text around, so reviewing will only consist of the structure, not the content.

The content might be inconsistent or incorrect, but that is how it is today. The next stages will update the content for clarity, consistency, and correctness.

New Organization

  • Moved sections and files around to new folder structure
  • Renamed additionaldocs to docs
  • Updated doc links across the repo

Main sections within docs/

  • Administration - docs related to logs, health check, backups, etc
  • Deployment - docs related to different ways to deploy Graph Explorer and configuration
  • Development - docs related to development tasks and contribution
  • Getting Started - guides related to first time users
  • Troubleshooting - guides related to helping fix common issues
  • User Guide - docs related to feature explorations

Next Steps

For clarity, my next set of goals include:

  1. Consolidate environment variable configuration information
  2. Add quick start guide using air routes sample
  3. Add clarifying text for sections that don't make much sense right now

Validation

  • Suggest reviewing commit by commit

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0
    license.
  • I have run pnpm checks to ensure code compiles and meets standards.
  • I have run pnpm test to check if all tests are passing.
  • I have covered new added functionality with unit tests if necessary.
  • I have added an entry in the Changelog.md.

@kmcginnes kmcginnes force-pushed the feature/docs/organize branch from 20f197c to aab8182 Compare September 12, 2025 18:39
@kmcginnes kmcginnes marked this pull request as ready for review September 12, 2025 19:44
@kmcginnes kmcginnes marked this pull request as draft September 17, 2025 14:00
@kmcginnes
Copy link
Collaborator Author

Putting this back to draft while I focus on SPARQL queries

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.

Organize documentation files

1 participant