Skip to content

Latest commit

 

History

History
71 lines (67 loc) · 12.2 KB

.docindex.md

File metadata and controls

71 lines (67 loc) · 12.2 KB

Documentation Index

This file serves as an index for all .md files in the project. It provides a brief description of what information can be found in each file.

Generated with ChatGPT using Co-Developer GPT engine and prompt: Update a file .docindex.md that contains an index of all .md files in the project, as a helper for locating a documentation. For each .md file it should have an entry that tells what information is found there. (Not a summary - the file should help to find the right .md file). Index only markdown files which are named with extension .md, nothing else. Go step by step: first check what entries docindex.md already has, then list what .md files are there, read a .md file for which there is no entry yet and create it in docindex.md, until all files are indexed. Continue without asking until all is done.

The index

  • aem/README.md: This file provides the Composum AI for use in the AEM author host. It is based on the AEM archetype version 37 and focuses on supporting the author.
  • aem/ui.apps/src/test/content/jcr_root/apps/composum-ai/test/components/TestContent-Apps.md: This directory contains only content needed for testing or developing the application. It is normally not deployed.
  • aem/ui.content/src/test/content/TestContent-Content.md: This directory contains content needed for testing or developing the application within the WKND site. It is normally not deployed.
  • aem/ui.frontend/README.md: This file outlines the frontend build features, including TypeScript, ES6 and ES5 support, linting, and globbing.
  • archive/investigations/VideoTest.md: This file documents unsuccessful attempts to display videos in Github Markdown.
  • archive/talks/README.md: This file contains details about a talk on Composum AI presented at JUG Saxony Day 2023.
  • Architecture.md: This file documents the architecture of this application and records implementation decisions that were taken and their reasons.
  • BusinessPerspective.md: This file discusses the Composum AI project from a business perspective, detailing how it enhances content management in Composum Pages by providing AI-assisted features such as translation, content creation, and SEO keyword suggestion.
  • ChatGPTAPI.md: This file provides an analysis of the ChatGPT API in relation to the needs of the project. It focuses on the ChatGPT chat API with gpt-4o-mini.
  • NextSteps.md: This file outlines the next steps in the implementation of the project, including the basic steps for implementing a translation service.
  • ProjectStructure.md: This file provides an overview of the planned project structure, including the backend services and the basic strategies for ChatGPT API access.
  • README.md: This file provides an overview of the Composum AI project, including the basic idea, current status, future ideas, and how to try it out. It also discusses the use of AI services, in particular ChatGPT and the Github Copilot IntelliJ plugin, for speeding up development.
  • Releasing.md: This file contains internal remarks about preparing a release for the Composum AI project, including a checklist of steps to follow.
  • Videos.md: This file contains notes on what to show in the demo videos for the Composum AI project.
  • chatgpt.codeRules.md: This file outlines the general rules for ChatGPT coding in this project, including guidelines on clean code conventions, best practices, and specific instructions for unit testing.
  • composum/ComposumIntegration.md: This file provides details about the Composum integration of the module, including the location of integration in the UI, the mechanism for embedding buttons into widget labels, and relevant files in Composum Pages.
  • composum/package/ComposumSpecificPrompts.md: This file contains prompts for ChatGPT for Composum specific things, including instructions for adding title attributes for the UI elements and rewriting labels.
  • featurespecs/0TranslationDialog.md: This file provides a detailed feature specification of the Translation Dialog, including the background, basic feature idea, basic implementation decisions, user workflow, dialog elements, structure of the dialog, user interaction diagram, stati of the dialog, Composum implementation references, test cases, and possible extensions.
  • featurespecs/1ContentCreationDialog.md: This file provides a comprehensive feature specification of the Content Creation Dialog. It includes the basic idea, implementation decisions, user workflow, dialog elements, structure of the dialog, user interaction diagram, saving state, implementation plan, test cases, and possible extensions.
  • featurespecs/2PageCategoryDialog.md: This file provides a detailed feature specification for a dialog to support setting page categories in Composum Pages, utilizing the AI capabilities of ChatGPT to suggest categories.
  • featurespecs/3SidebarDialog.md: This file provides a feature specification of the general sidebar AI Dialog in Composum Pages, detailing the integration of a new AI-assisted sidebar in the WYSIWYG editor for creating, editing, and arranging page components.
  • featurespecs/4SSEStreaming.md: This file discusses the use of streaming responses to improve user experience in the Composum AI project, focusing on the use of the Server-Sent Events (SSE) streaming API due to the slow response time of the ChatGPT completion API.
  • featurespecs/ComposumIntegrationArchitecture.md: This file provides an overview of the general architecture of the Composum integration in the Composum AI project, including details on naming conventions and servlets.
  • featurespecs/FeatureCreationProcess.md: This file provides ideas and guidelines on how to create a feature with ChatGPT support, including an approach using the ChatGPT chat interface for feedback and support during the feature specification and implementation process.
  • featurespecs/FeatureIdeas.md: This file is a brainstorming list of potential features that could be supported in the Composum AI project, although they are not currently planned for implementation.
  • featurespecs/SecurityConsiderations.md: This file discusses the security considerations that need to be taken into account across all features in the Composum AI project, including the potential problem of prompt injection.
  • featurespecs/5Restrictions.md: This file discusses the implementation of a service/servlet for configuring application restrictions.
  • featurespecs/6Configuration.md: This file outlines the configuration options for Composum AI, including API key and rate limiting.
  • featurespecs/AEMIntegrationIdeas.md: This file discusses ideas for integrating Composum AI with AEM, including test setups and frontend development options.
  • featurespecs/AemIntegrationArchitecture.md: This file outlines the architecture decisions for integrating Composum AI with AEM, discussing the scope and limitations.
  • featurespecs/CommonConventions.md: This file outlines common conventions for dialog submissions and history modules in the project.
  • featurespecs/FeatureVideos.md: This file provides guidelines for creating demo videos for the project, including screen recording and compression techniques.
  • featurespecs/Testcases.md: This file outlines general test cases to be performed before preparing a release, in addition to feature-specific test cases.
  • featurespecs/7Imagerecognition.md: Discusses adding ChatGPT image recognition to the content creation dialog, including implementation details, vision model configuration, and handling in Composum and AEM.
  • featurespecs/8AutomaticTranslation.md: Describes the rationale, basic idea, and technical details for implementing an automatic translation process to efficiently translate pages, page trees, or entire sites. It covers handling references to assets, dealing with language copies in AEM, and includes considerations for experience and content fragments, as well as asset translations.
  • featurespecs/ChatCompletionInterface.md: Provides the specification for a ChatGPT Chat Completion Interface, focusing on code generation. Details include basic implementation decisions, request and response structure, and handling of streaming responses, with specific attention to JSON serialization and Java class structure.
  • src/site/markdown/aem-variant/configuration.md: Provides instructions on configuring Composum AI in AEM, detailing the setup of the OpenAI API key and managing AI permissions to tailor AI capabilities to specific needs and security requirements.
  • src/site/markdown/aem-variant/index.md: Overview of Composum AI for Adobe AEM 6.5 and AEMaaCS, featuring two assistant dialogs for content generation and analysis. Includes references to prompt examples, detailed usage documentation, installation instructions, and the open-source project.
  • src/site/markdown/aem-variant/installation.md: Describes the process for installing Composum AI in Adobe AEM, including requirements, package deployment, and setting up the OpenAI API key.
  • src/site/markdown/aem-variant/usage.md: Provides detailed instructions on using Composum AI for AEM, including how to access and utilize the Content Creation Assistant and the Side Panel AI.
  • src/site/markdown/composum-variant/configuration.md: Describes the configuration options for Composum AI within Composum Pages, including OpenAI API key setup and permissions management through OSGI and Sling Context Aware Configurations.
  • src/site/markdown/composum-variant/index.md: Introduces Composum AI for Composum Pages, detailing its functionalities such as translation, content creation, side panel AI for text analysis, and page category suggestions.
  • src/site/markdown/composum-variant/installation.md: Describes how to install Composum AI in Composum Pages, including methods for quick trials and detailed setup instructions for integration.
  • src/site/markdown/composum-variant/usage.md: Explains how to utilize Composum AI for Composum Pages, covering access to various AI assistants for translation, content creation, SEO optimization, and page categorization.
  • src/site/markdown/development.md: Provides links to Composum AI's GitHub sources, issue tracker, and development documentation. It also discusses the project's use of AI services, like ChatGPT and GitHub Copilot, to enhance development processes.
  • src/site/markdown/index.md: Main landing page for Composum AI, detailing its integration with Adobe Experience Manager and Composum Pages, including a basic overview, functionality, and trial information.
  • featurespecs/ChatCompletionInterface.md: Describes the ChatGPT Chat Completion Interface for code generation, including basic implementation decisions, request and response formats, and handling of streaming responses.