Herman/Yiqun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update prompts and docs sections

Browse Source
This commit is contained in:
Laura Abro
2025-04-24 22:02:03 -03:00
parent 5c41ec9119
commit 8f12e574db
4 changed files with 10 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
worker/orca-agent/src/server/services/audit_service.py
View File

@ -42,6 +42,7 @@ def audit_repo(pr_url):
if __name__ == "__main__":
# review_pr(["https://github.com/alexander-morris/koii-dumper-reveal"], "https://github.com/koii-network/namespace-wrapper/pull/1", "HermanL02")
# review_pr(["https://github.com/alexander-morris/koii-dumper-reveal"],
# "https://github.com/koii-network/namespace-wrapper/pull/1", "HermanL02")
audit_repo("https://github.com/koii-network/namespace-wrapper/pull/1")

56
worker/orca-agent/src/workflows/repoSummarizer/docs_sections.py
View File

@ -20,10 +20,6 @@ DOCS_SECTIONS = {
"description": "Describe how to build and deploy the application to production\n"
"Include relevant deployment commands and target platforms (e.g., Vercel, Netlify, Docker)\n\n",
},
{
"name": "Technologies Used",
"description": "List the main frameworks, libraries, and tools (e.g., React, Vue, Vite, Tailwind)\n\n",
},
{
"name": "Feature Highlights",
"description": "Describe core user-facing features or flows "
@ -50,10 +46,6 @@ DOCS_SECTIONS = {
"description": "Describe how authentication works (e.g., API keys, OAuth, JWT)\n"
"Include example headers or auth flow steps if needed\n\n",
},
{
"name": "Technologies Used",
"description": "List major frameworks, libraries, or tools (e.g., Express, FastAPI, Prisma)\n\n",
},
{
"name": "Deployment",
"description": "Describe how to deploy the service (e.g., Docker, CI/CD, cloud platforms)\n"
@ -71,10 +63,6 @@ DOCS_SECTIONS = {
"description": "Show commands to run the app on a simulator/emulator or real device\n"
"Include platform-specific commands if needed (e.g., `npx react-native run-ios`, `flutter run`)\n\n",
},
{
"name": "Technologies Used",
"description": "List the frameworks, SDKs, and libraries used (e.g., React Native, Flutter, Firebase)\n\n",
},
{
"name": "Key Screens and Features",
"description": "Highlight core screens or flows within the app (e.g., login, profile, dashboard)\n"
@ -114,11 +102,6 @@ DOCS_SECTIONS = {
"description": "Explain which parts of the codebase are intended to be modified by users\n"
"Offer guidance on how to rename, rebrand, or restructure parts of the template\n\n",
},
{
"name": "Technologies Used",
"description": "List the frameworks, libraries, and tools integrated into the template "
"(e.g., ESLint, Prettier, Tailwind, Express)\n\n",
},
{
"name": "Use Cases",
"description": "Provide example scenarios where this template is useful "
@ -158,10 +141,6 @@ DOCS_SECTIONS = {
"(e.g., plugins, middleware, custom components)\n"
"Include examples of common extension use cases\n\n",
},
{
"name": "Technologies Used",
"description": "List core dependencies, supported environments, or language-level features leveraged\n\n",
},
{
"name": "Best Practices",
"description": "Offer guidance for structuring large projects, writing maintainable code, or "
@ -190,10 +169,6 @@ DOCS_SECTIONS = {
"description": "Explain how to run inference or apply the model to new data\n"
"Include input/output formats and example commands or code\n\n",
},
{
"name": "Technologies Used",
"description": "List key tools, libraries, and frameworks (e.g., scikit-learn, TensorFlow, pandas)\n\n",
},
],
"plugin": [
{
@ -205,10 +180,6 @@ DOCS_SECTIONS = {
"name": "Integration Points",
"description": "Describe hooks, lifecycle methods, or extension APIs the plugin interacts with\n\n",
},
{
"name": "Technologies Used",
"description": "List frameworks, languages, or tooling\n\n",
},
],
"chrome_extension": [
{
@ -217,10 +188,6 @@ DOCS_SECTIONS = {
"(e.g., popup UI, context menu, background scripts)\n"
"Include example scenarios or screenshots if applicable\n\n",
},
{
"name": "Technologies Used",
"description": "List libraries or frameworks (e.g., vanilla JS, React, Tailwind)\n\n",
},
],
"jupyter_notebook": [
{
@ -232,10 +199,6 @@ DOCS_SECTIONS = {
"name": "Dataset (if applicable)",
"description": "Describe any datasets used and where they come from\n\n",
},
{
"name": "Technologies Used",
"description": "List libraries (e.g., pandas, matplotlib, scikit-learn)\n\n",
},
],
"infrastructure": [
{
@ -288,10 +251,6 @@ DOCS_SECTIONS = {
"description": "Explain player controls and core mechanics\n"
"Optionally include screenshots, video, or demo links\n\n",
},
{
"name": "Technologies Used",
"description": "List engines, frameworks, or libraries used to build the game\n\n",
},
],
"desktop_app": [
{
@ -299,10 +258,6 @@ DOCS_SECTIONS = {
"description": "Describe the app's main features and user workflows\n"
"Include screenshots if applicable\n\n",
},
{
"name": "Technologies Used",
"description": "List major libraries, frameworks, and build tools\n\n",
},
],
"dataset": [
{
@ -327,10 +282,6 @@ DOCS_SECTIONS = {
"description": "List the core features or components of the project\n"
"Include relevant examples, demos, or configurations if applicable\n\n",
},
{
"name": "Technologies Used",
"description": "List any major frameworks, libraries, or languages identified in the project\n\n",
},
{
"name": "Usage Examples",
"description": "Include example commands or steps showing how to use the project\n\n",
@ -358,7 +309,12 @@ INITIAL_SECTIONS = [
FINAL_SECTIONS = [
{
"name": "Project Structure",
"description": "Briefly explain the purpose of key directories and files\n\n",
"description": "Describe the layout of the project, highlighting the purpose of key directories and files\n\n",
},
{
"name": "Technologies Used",
"description": "List the major technologies used in the project, including "
"frameworks, libraries, SDKs, and tools\n\n",
},
{
"name": "Additional Notes",

3
worker/orca-agent/src/workflows/repoSummarizer/prompts.py
View File

@ -57,7 +57,6 @@ PROMPTS = {
"Create the documentation based SOLELY on the files actually present in the codebase.\n"
"EXTREMELY IMPORTANT: If files are mentioned in the README but are not present in the codebase, "
"do NOT mention them in your documentation. They do not exist and are not relevant.\n"
"If this section is not relevant to the repository, return an empty string.\n"
),
"generate_readme": (
"Create a descriptive title for the following README contents and create the README file:\n"
@ -77,7 +76,7 @@ PROMPTS = {
" - The main features and value of the documentation\n"
),
"review_readme_file": (
"Review the README_Prometheus.md file in the repository and evaluate its quality and "
"Review the README_Prometheus.md (NOT the README.md file) in the repository and evaluate its quality and "
"relevance to the repository.\n\n"
"Please analyze:\n"
"1. Is the README_Prometheus.md file related to this specific repository? (Does it describe the actual code "

2
worker/orca-agent/tests/steps.py
View File

@ -61,6 +61,6 @@ steps = [
description="Update audit results",
prepare=partial(update_audit.prepare, role="worker"),
execute=update_audit.execute,
worker="worker1",
worker="worker2",
),
]