{"id":30805566,"url":"https://github.com/aaronsb/target-process-docs","last_synced_at":"2025-09-06T00:59:09.842Z","repository":{"id":279314625,"uuid":"938411005","full_name":"aaronsb/target-process-docs","owner":"aaronsb","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-14T17:43:00.000Z","size":635,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-14T18:49:38.325Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aaronsb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-24T23:05:46.000Z","updated_at":"2025-05-14T17:43:03.000Z","dependencies_parsed_at":"2025-05-14T18:41:35.690Z","dependency_job_id":null,"html_url":"https://github.com/aaronsb/target-process-docs","commit_stats":null,"previous_names":["aaronsb/target-process-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aaronsb/target-process-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronsb%2Ftarget-process-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronsb%2Ftarget-process-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronsb%2Ftarget-process-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronsb%2Ftarget-process-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaronsb","download_url":"https://codeload.github.com/aaronsb/target-process-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronsb%2Ftarget-process-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273842816,"owners_count":25177921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-06T00:59:07.706Z","updated_at":"2025-09-06T00:59:09.827Z","avatar_url":"https://github.com/aaronsb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Target Process Documentation Scraper\n\nThis tool scrapes Target Process documentation and provides searchable local markdown files. It includes the ability to scrape general documentation, site-specific API documentation, and generate OpenAPI specifications.\n\n## Features\n\n- Scrapes general documentation from dev.targetprocess.com/docs\n- Converts HTML to markdown format\n- Creates a searchable SQLite database with full-text search\n- Scrapes site-specific API documentation from Target Process instances\n- Generates OpenAPI specifications from site-specific API metadata\n- Visualizes documentation relationships in an interactive 3D graph\n- Unified interactive script for all operations\n- Organized output in a centralized directory structure\n\n## Installation\n\n```bash\ngit clone \u003cthis-repository\u003e\ncd target-process-docs\nnpm install\n```\n\n## Quick Start\n\nRun the unified interactive script:\n\n```bash\nnode tp-docs.js\n# or\nnpm start\n```\n\nThis will guide you through the available options:\n- Scraping general documentation from dev.targetprocess.com\n- Scraping API documentation from a specific Target Process site\n- Generating OpenAPI specifications\n- Visualizing documentation relationships\n\n## Directory Structure\n\nAll generated content is stored in the `generated/` directory:\n\n```\ngenerated/\n├── dev-docs/       # General documentation\n├── api-docs/       # Site-specific API documentation\n│   └── sitename/   # Each site gets its own directory\n├── openapi/        # OpenAPI specifications\n├── database/       # Search database and metadata\n└── visualization/  # Visualization assets\n```\n\n## Using the Generated Documentation\n\n### General Documentation\n\nGeneral documentation is stored as markdown files in the `generated/dev-docs/` directory. You can:\n- Read it directly in any markdown viewer\n- Search it using the database\n- Visualize document relationships using the visualization tool\n\n### Site-Specific API Documentation\n\nAPI documentation is stored in `generated/api-docs/sitename/markdown/`. It includes:\n- An index of all available resources\n- Detailed documentation for each resource including properties, operations, and relationships\n- Links between related resources\n\n### OpenAPI Specification\n\nThe generated OpenAPI specification can be:\n- Imported into tools like Swagger UI, Postman, or Insomnia\n- Used to generate client libraries using tools like OpenAPI Generator\n- Used as reference documentation for developers\n\n### Visualization\n\nThe visualization tool provides an interactive 3D graph of documentation relationships:\n- Documents and sections are represented as nodes\n- Relationships between nodes are represented as links\n- Nodes are color-coded by category\n- You can filter, search, and interact with the graph\n\n### Search Tool\n\nThe search tool provides a command-line interface for searching the documentation database:\n- Full-text search of documents and sections\n- Filter results by category\n- View context around matches\n- Limit number of results\n- Exact phrase matching\n\n```bash\n# Basic search\nnode search-docs.js \"user story\"\n\n# Search only in documents\nnode search-docs.js -t docs \"api\"\n\n# Filter by category\nnode search-docs.js -c feature \"epic\"\n\n# Exact phrase matching\nnode search-docs.js -e \"acceptance criteria\"\n\n# List available categories\nnode search-docs.js --list-categories\n\n# Get help\nnode search-docs.js --help\n```\n\n## NPM Scripts\n\n```bash\nnpm start            # Run the unified interactive script\nnpm run dev-docs     # Run the general documentation scraper\nnpm run build-search # Build the search database\nnpm run visualize    # Generate visualization\nnpm run api-scrape   # Run the site-specific API scraper (requires --site param)\nnpm run generate-openapi # Generate OpenAPI spec (requires --site param)\nnpm run search       # Search the documentation database\n```\n\n## Notes\n\n- Site-specific resources may include custom entities that do not exist in the general documentation\n- The OpenAPI specification includes standard CRUD operations for all resources\n- Authentication methods supported include Basic Auth and API Token\n- Generated content is excluded from git to prevent repository bloat\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronsb%2Ftarget-process-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaronsb%2Ftarget-process-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronsb%2Ftarget-process-docs/lists"}