diff --git a/docs/api-reference/core/Argument.mdx b/docs/_deprecated/api-reference/core/Argument.mdx similarity index 100% rename from docs/api-reference/core/Argument.mdx rename to docs/_deprecated/api-reference/core/Argument.mdx diff --git a/docs/api-reference/core/Assignment.mdx b/docs/_deprecated/api-reference/core/Assignment.mdx similarity index 100% rename from docs/api-reference/core/Assignment.mdx rename to docs/_deprecated/api-reference/core/Assignment.mdx diff --git a/docs/api-reference/core/AssignmentStatement.mdx b/docs/_deprecated/api-reference/core/AssignmentStatement.mdx similarity index 100% rename from docs/api-reference/core/AssignmentStatement.mdx rename to docs/_deprecated/api-reference/core/AssignmentStatement.mdx diff --git a/docs/api-reference/core/Attribute.mdx b/docs/_deprecated/api-reference/core/Attribute.mdx similarity index 100% rename from docs/api-reference/core/Attribute.mdx rename to docs/_deprecated/api-reference/core/Attribute.mdx diff --git a/docs/api-reference/core/AwaitExpression.mdx b/docs/_deprecated/api-reference/core/AwaitExpression.mdx similarity index 100% rename from docs/api-reference/core/AwaitExpression.mdx rename to docs/_deprecated/api-reference/core/AwaitExpression.mdx diff --git a/docs/api-reference/core/BinaryExpression.mdx b/docs/_deprecated/api-reference/core/BinaryExpression.mdx similarity index 100% rename from docs/api-reference/core/BinaryExpression.mdx rename to docs/_deprecated/api-reference/core/BinaryExpression.mdx diff --git a/docs/api-reference/core/BlockStatement.mdx b/docs/_deprecated/api-reference/core/BlockStatement.mdx similarity index 100% rename from docs/api-reference/core/BlockStatement.mdx rename to docs/_deprecated/api-reference/core/BlockStatement.mdx diff --git a/docs/api-reference/core/Boolean.mdx b/docs/_deprecated/api-reference/core/Boolean.mdx similarity index 100% rename from docs/api-reference/core/Boolean.mdx rename to docs/_deprecated/api-reference/core/Boolean.mdx diff --git a/docs/api-reference/core/Callable.mdx b/docs/_deprecated/api-reference/core/Callable.mdx similarity index 100% rename from docs/api-reference/core/Callable.mdx rename to docs/_deprecated/api-reference/core/Callable.mdx diff --git a/docs/api-reference/core/CatchStatement.mdx b/docs/_deprecated/api-reference/core/CatchStatement.mdx similarity index 100% rename from docs/api-reference/core/CatchStatement.mdx rename to docs/_deprecated/api-reference/core/CatchStatement.mdx diff --git a/docs/api-reference/core/ChainedAttribute.mdx b/docs/_deprecated/api-reference/core/ChainedAttribute.mdx similarity index 100% rename from docs/api-reference/core/ChainedAttribute.mdx rename to docs/_deprecated/api-reference/core/ChainedAttribute.mdx diff --git a/docs/api-reference/core/Class.mdx b/docs/_deprecated/api-reference/core/Class.mdx similarity index 100% rename from docs/api-reference/core/Class.mdx rename to docs/_deprecated/api-reference/core/Class.mdx diff --git a/docs/api-reference/core/CodeBlock.mdx b/docs/_deprecated/api-reference/core/CodeBlock.mdx similarity index 100% rename from docs/api-reference/core/CodeBlock.mdx rename to docs/_deprecated/api-reference/core/CodeBlock.mdx diff --git a/docs/api-reference/core/CodeOwner.mdx b/docs/_deprecated/api-reference/core/CodeOwner.mdx similarity index 100% rename from docs/api-reference/core/CodeOwner.mdx rename to docs/_deprecated/api-reference/core/CodeOwner.mdx diff --git a/docs/api-reference/core/Codebase.mdx b/docs/_deprecated/api-reference/core/Codebase.mdx similarity index 100% rename from docs/api-reference/core/Codebase.mdx rename to docs/_deprecated/api-reference/core/Codebase.mdx diff --git a/docs/api-reference/core/Comment.mdx b/docs/_deprecated/api-reference/core/Comment.mdx similarity index 100% rename from docs/api-reference/core/Comment.mdx rename to docs/_deprecated/api-reference/core/Comment.mdx diff --git a/docs/api-reference/core/CommentGroup.mdx b/docs/_deprecated/api-reference/core/CommentGroup.mdx similarity index 100% rename from docs/api-reference/core/CommentGroup.mdx rename to docs/_deprecated/api-reference/core/CommentGroup.mdx diff --git a/docs/api-reference/core/ComparisonExpression.mdx b/docs/_deprecated/api-reference/core/ComparisonExpression.mdx similarity index 100% rename from docs/api-reference/core/ComparisonExpression.mdx rename to docs/_deprecated/api-reference/core/ComparisonExpression.mdx diff --git a/docs/api-reference/core/Decorator.mdx b/docs/_deprecated/api-reference/core/Decorator.mdx similarity index 100% rename from docs/api-reference/core/Decorator.mdx rename to docs/_deprecated/api-reference/core/Decorator.mdx diff --git a/docs/api-reference/core/Dict.mdx b/docs/_deprecated/api-reference/core/Dict.mdx similarity index 100% rename from docs/api-reference/core/Dict.mdx rename to docs/_deprecated/api-reference/core/Dict.mdx diff --git a/docs/api-reference/core/Directory.mdx b/docs/_deprecated/api-reference/core/Directory.mdx similarity index 100% rename from docs/api-reference/core/Directory.mdx rename to docs/_deprecated/api-reference/core/Directory.mdx diff --git a/docs/api-reference/core/Editable.mdx b/docs/_deprecated/api-reference/core/Editable.mdx similarity index 100% rename from docs/api-reference/core/Editable.mdx rename to docs/_deprecated/api-reference/core/Editable.mdx diff --git a/docs/api-reference/core/Export.mdx b/docs/_deprecated/api-reference/core/Export.mdx similarity index 100% rename from docs/api-reference/core/Export.mdx rename to docs/_deprecated/api-reference/core/Export.mdx diff --git a/docs/api-reference/core/ExportStatement.mdx b/docs/_deprecated/api-reference/core/ExportStatement.mdx similarity index 100% rename from docs/api-reference/core/ExportStatement.mdx rename to docs/_deprecated/api-reference/core/ExportStatement.mdx diff --git a/docs/api-reference/core/Exportable.mdx b/docs/_deprecated/api-reference/core/Exportable.mdx similarity index 100% rename from docs/api-reference/core/Exportable.mdx rename to docs/_deprecated/api-reference/core/Exportable.mdx diff --git a/docs/api-reference/core/Expression.mdx b/docs/_deprecated/api-reference/core/Expression.mdx similarity index 100% rename from docs/api-reference/core/Expression.mdx rename to docs/_deprecated/api-reference/core/Expression.mdx diff --git a/docs/api-reference/core/ExpressionGroup.mdx b/docs/_deprecated/api-reference/core/ExpressionGroup.mdx similarity index 100% rename from docs/api-reference/core/ExpressionGroup.mdx rename to docs/_deprecated/api-reference/core/ExpressionGroup.mdx diff --git a/docs/api-reference/core/ExpressionStatement.mdx b/docs/_deprecated/api-reference/core/ExpressionStatement.mdx similarity index 100% rename from docs/api-reference/core/ExpressionStatement.mdx rename to docs/_deprecated/api-reference/core/ExpressionStatement.mdx diff --git a/docs/api-reference/core/ExternalModule.mdx b/docs/_deprecated/api-reference/core/ExternalModule.mdx similarity index 100% rename from docs/api-reference/core/ExternalModule.mdx rename to docs/_deprecated/api-reference/core/ExternalModule.mdx diff --git a/docs/api-reference/core/File.mdx b/docs/_deprecated/api-reference/core/File.mdx similarity index 100% rename from docs/api-reference/core/File.mdx rename to docs/_deprecated/api-reference/core/File.mdx diff --git a/docs/api-reference/core/FlagKwargs.mdx b/docs/_deprecated/api-reference/core/FlagKwargs.mdx similarity index 100% rename from docs/api-reference/core/FlagKwargs.mdx rename to docs/_deprecated/api-reference/core/FlagKwargs.mdx diff --git a/docs/api-reference/core/ForLoopStatement.mdx b/docs/_deprecated/api-reference/core/ForLoopStatement.mdx similarity index 100% rename from docs/api-reference/core/ForLoopStatement.mdx rename to docs/_deprecated/api-reference/core/ForLoopStatement.mdx diff --git a/docs/api-reference/core/Function.mdx b/docs/_deprecated/api-reference/core/Function.mdx similarity index 100% rename from docs/api-reference/core/Function.mdx rename to docs/_deprecated/api-reference/core/Function.mdx diff --git a/docs/api-reference/core/FunctionCall.mdx b/docs/_deprecated/api-reference/core/FunctionCall.mdx similarity index 100% rename from docs/api-reference/core/FunctionCall.mdx rename to docs/_deprecated/api-reference/core/FunctionCall.mdx diff --git a/docs/api-reference/core/GenericType.mdx b/docs/_deprecated/api-reference/core/GenericType.mdx similarity index 100% rename from docs/api-reference/core/GenericType.mdx rename to docs/_deprecated/api-reference/core/GenericType.mdx diff --git a/docs/api-reference/core/HasBlock.mdx b/docs/_deprecated/api-reference/core/HasBlock.mdx similarity index 100% rename from docs/api-reference/core/HasBlock.mdx rename to docs/_deprecated/api-reference/core/HasBlock.mdx diff --git a/docs/api-reference/core/HasName.mdx b/docs/_deprecated/api-reference/core/HasName.mdx similarity index 100% rename from docs/api-reference/core/HasName.mdx rename to docs/_deprecated/api-reference/core/HasName.mdx diff --git a/docs/api-reference/core/HasValue.mdx b/docs/_deprecated/api-reference/core/HasValue.mdx similarity index 100% rename from docs/api-reference/core/HasValue.mdx rename to docs/_deprecated/api-reference/core/HasValue.mdx diff --git a/docs/api-reference/core/IfBlockStatement.mdx b/docs/_deprecated/api-reference/core/IfBlockStatement.mdx similarity index 100% rename from docs/api-reference/core/IfBlockStatement.mdx rename to docs/_deprecated/api-reference/core/IfBlockStatement.mdx diff --git a/docs/api-reference/core/Import.mdx b/docs/_deprecated/api-reference/core/Import.mdx similarity index 100% rename from docs/api-reference/core/Import.mdx rename to docs/_deprecated/api-reference/core/Import.mdx diff --git a/docs/api-reference/core/ImportStatement.mdx b/docs/_deprecated/api-reference/core/ImportStatement.mdx similarity index 100% rename from docs/api-reference/core/ImportStatement.mdx rename to docs/_deprecated/api-reference/core/ImportStatement.mdx diff --git a/docs/api-reference/core/ImportType.mdx b/docs/_deprecated/api-reference/core/ImportType.mdx similarity index 100% rename from docs/api-reference/core/ImportType.mdx rename to docs/_deprecated/api-reference/core/ImportType.mdx diff --git a/docs/api-reference/core/Importable.mdx b/docs/_deprecated/api-reference/core/Importable.mdx similarity index 100% rename from docs/api-reference/core/Importable.mdx rename to docs/_deprecated/api-reference/core/Importable.mdx diff --git a/docs/api-reference/core/Interface.mdx b/docs/_deprecated/api-reference/core/Interface.mdx similarity index 100% rename from docs/api-reference/core/Interface.mdx rename to docs/_deprecated/api-reference/core/Interface.mdx diff --git a/docs/api-reference/core/List.mdx b/docs/_deprecated/api-reference/core/List.mdx similarity index 100% rename from docs/api-reference/core/List.mdx rename to docs/_deprecated/api-reference/core/List.mdx diff --git a/docs/api-reference/core/MessageType.mdx b/docs/_deprecated/api-reference/core/MessageType.mdx similarity index 100% rename from docs/api-reference/core/MessageType.mdx rename to docs/_deprecated/api-reference/core/MessageType.mdx diff --git a/docs/api-reference/core/MultiExpression.mdx b/docs/_deprecated/api-reference/core/MultiExpression.mdx similarity index 100% rename from docs/api-reference/core/MultiExpression.mdx rename to docs/_deprecated/api-reference/core/MultiExpression.mdx diff --git a/docs/api-reference/core/MultiLineCollection.mdx b/docs/_deprecated/api-reference/core/MultiLineCollection.mdx similarity index 100% rename from docs/api-reference/core/MultiLineCollection.mdx rename to docs/_deprecated/api-reference/core/MultiLineCollection.mdx diff --git a/docs/api-reference/core/Name.mdx b/docs/_deprecated/api-reference/core/Name.mdx similarity index 100% rename from docs/api-reference/core/Name.mdx rename to docs/_deprecated/api-reference/core/Name.mdx diff --git a/docs/api-reference/core/NamedType.mdx b/docs/_deprecated/api-reference/core/NamedType.mdx similarity index 100% rename from docs/api-reference/core/NamedType.mdx rename to docs/_deprecated/api-reference/core/NamedType.mdx diff --git a/docs/api-reference/core/NoneType.mdx b/docs/_deprecated/api-reference/core/NoneType.mdx similarity index 100% rename from docs/api-reference/core/NoneType.mdx rename to docs/_deprecated/api-reference/core/NoneType.mdx diff --git a/docs/api-reference/core/Number.mdx b/docs/_deprecated/api-reference/core/Number.mdx similarity index 100% rename from docs/api-reference/core/Number.mdx rename to docs/_deprecated/api-reference/core/Number.mdx diff --git a/docs/api-reference/core/Pair.mdx b/docs/_deprecated/api-reference/core/Pair.mdx similarity index 100% rename from docs/api-reference/core/Pair.mdx rename to docs/_deprecated/api-reference/core/Pair.mdx diff --git a/docs/api-reference/core/Parameter.mdx b/docs/_deprecated/api-reference/core/Parameter.mdx similarity index 100% rename from docs/api-reference/core/Parameter.mdx rename to docs/_deprecated/api-reference/core/Parameter.mdx diff --git a/docs/api-reference/core/ParenthesizedExpression.mdx b/docs/_deprecated/api-reference/core/ParenthesizedExpression.mdx similarity index 100% rename from docs/api-reference/core/ParenthesizedExpression.mdx rename to docs/_deprecated/api-reference/core/ParenthesizedExpression.mdx diff --git a/docs/api-reference/core/Placeholder.mdx b/docs/_deprecated/api-reference/core/Placeholder.mdx similarity index 100% rename from docs/api-reference/core/Placeholder.mdx rename to docs/_deprecated/api-reference/core/Placeholder.mdx diff --git a/docs/api-reference/core/PlaceholderType.mdx b/docs/_deprecated/api-reference/core/PlaceholderType.mdx similarity index 100% rename from docs/api-reference/core/PlaceholderType.mdx rename to docs/_deprecated/api-reference/core/PlaceholderType.mdx diff --git a/docs/api-reference/core/RaiseStatement.mdx b/docs/_deprecated/api-reference/core/RaiseStatement.mdx similarity index 100% rename from docs/api-reference/core/RaiseStatement.mdx rename to docs/_deprecated/api-reference/core/RaiseStatement.mdx diff --git a/docs/api-reference/core/ReturnStatement.mdx b/docs/_deprecated/api-reference/core/ReturnStatement.mdx similarity index 100% rename from docs/api-reference/core/ReturnStatement.mdx rename to docs/_deprecated/api-reference/core/ReturnStatement.mdx diff --git a/docs/api-reference/core/SourceFile.mdx b/docs/_deprecated/api-reference/core/SourceFile.mdx similarity index 100% rename from docs/api-reference/core/SourceFile.mdx rename to docs/_deprecated/api-reference/core/SourceFile.mdx diff --git a/docs/api-reference/core/Span.mdx b/docs/_deprecated/api-reference/core/Span.mdx similarity index 100% rename from docs/api-reference/core/Span.mdx rename to docs/_deprecated/api-reference/core/Span.mdx diff --git a/docs/api-reference/core/Statement.mdx b/docs/_deprecated/api-reference/core/Statement.mdx similarity index 100% rename from docs/api-reference/core/Statement.mdx rename to docs/_deprecated/api-reference/core/Statement.mdx diff --git a/docs/api-reference/core/StatementType.mdx b/docs/_deprecated/api-reference/core/StatementType.mdx similarity index 100% rename from docs/api-reference/core/StatementType.mdx rename to docs/_deprecated/api-reference/core/StatementType.mdx diff --git a/docs/api-reference/core/String.mdx b/docs/_deprecated/api-reference/core/String.mdx similarity index 100% rename from docs/api-reference/core/String.mdx rename to docs/_deprecated/api-reference/core/String.mdx diff --git a/docs/api-reference/core/StubPlaceholder.mdx b/docs/_deprecated/api-reference/core/StubPlaceholder.mdx similarity index 100% rename from docs/api-reference/core/StubPlaceholder.mdx rename to docs/_deprecated/api-reference/core/StubPlaceholder.mdx diff --git a/docs/api-reference/core/SubscriptExpression.mdx b/docs/_deprecated/api-reference/core/SubscriptExpression.mdx similarity index 100% rename from docs/api-reference/core/SubscriptExpression.mdx rename to docs/_deprecated/api-reference/core/SubscriptExpression.mdx diff --git a/docs/api-reference/core/SwitchCase.mdx b/docs/_deprecated/api-reference/core/SwitchCase.mdx similarity index 100% rename from docs/api-reference/core/SwitchCase.mdx rename to docs/_deprecated/api-reference/core/SwitchCase.mdx diff --git a/docs/api-reference/core/SwitchStatement.mdx b/docs/_deprecated/api-reference/core/SwitchStatement.mdx similarity index 100% rename from docs/api-reference/core/SwitchStatement.mdx rename to docs/_deprecated/api-reference/core/SwitchStatement.mdx diff --git a/docs/api-reference/core/Symbol.mdx b/docs/_deprecated/api-reference/core/Symbol.mdx similarity index 100% rename from docs/api-reference/core/Symbol.mdx rename to docs/_deprecated/api-reference/core/Symbol.mdx diff --git a/docs/api-reference/core/SymbolGroup.mdx b/docs/_deprecated/api-reference/core/SymbolGroup.mdx similarity index 100% rename from docs/api-reference/core/SymbolGroup.mdx rename to docs/_deprecated/api-reference/core/SymbolGroup.mdx diff --git a/docs/api-reference/core/SymbolStatement.mdx b/docs/_deprecated/api-reference/core/SymbolStatement.mdx similarity index 100% rename from docs/api-reference/core/SymbolStatement.mdx rename to docs/_deprecated/api-reference/core/SymbolStatement.mdx diff --git a/docs/api-reference/core/TernaryExpression.mdx b/docs/_deprecated/api-reference/core/TernaryExpression.mdx similarity index 100% rename from docs/api-reference/core/TernaryExpression.mdx rename to docs/_deprecated/api-reference/core/TernaryExpression.mdx diff --git a/docs/api-reference/core/TryCatchStatement.mdx b/docs/_deprecated/api-reference/core/TryCatchStatement.mdx similarity index 100% rename from docs/api-reference/core/TryCatchStatement.mdx rename to docs/_deprecated/api-reference/core/TryCatchStatement.mdx diff --git a/docs/api-reference/core/Tuple.mdx b/docs/_deprecated/api-reference/core/Tuple.mdx similarity index 100% rename from docs/api-reference/core/Tuple.mdx rename to docs/_deprecated/api-reference/core/Tuple.mdx diff --git a/docs/api-reference/core/TupleType.mdx b/docs/_deprecated/api-reference/core/TupleType.mdx similarity index 100% rename from docs/api-reference/core/TupleType.mdx rename to docs/_deprecated/api-reference/core/TupleType.mdx diff --git a/docs/api-reference/core/Type.mdx b/docs/_deprecated/api-reference/core/Type.mdx similarity index 100% rename from docs/api-reference/core/Type.mdx rename to docs/_deprecated/api-reference/core/Type.mdx diff --git a/docs/api-reference/core/TypeAlias.mdx b/docs/_deprecated/api-reference/core/TypeAlias.mdx similarity index 100% rename from docs/api-reference/core/TypeAlias.mdx rename to docs/_deprecated/api-reference/core/TypeAlias.mdx diff --git a/docs/api-reference/core/TypePlaceholder.mdx b/docs/_deprecated/api-reference/core/TypePlaceholder.mdx similarity index 100% rename from docs/api-reference/core/TypePlaceholder.mdx rename to docs/_deprecated/api-reference/core/TypePlaceholder.mdx diff --git a/docs/api-reference/core/Typeable.mdx b/docs/_deprecated/api-reference/core/Typeable.mdx similarity index 100% rename from docs/api-reference/core/Typeable.mdx rename to docs/_deprecated/api-reference/core/Typeable.mdx diff --git a/docs/api-reference/core/UnaryExpression.mdx b/docs/_deprecated/api-reference/core/UnaryExpression.mdx similarity index 100% rename from docs/api-reference/core/UnaryExpression.mdx rename to docs/_deprecated/api-reference/core/UnaryExpression.mdx diff --git a/docs/api-reference/core/UnionType.mdx b/docs/_deprecated/api-reference/core/UnionType.mdx similarity index 100% rename from docs/api-reference/core/UnionType.mdx rename to docs/_deprecated/api-reference/core/UnionType.mdx diff --git a/docs/api-reference/core/Unpack.mdx b/docs/_deprecated/api-reference/core/Unpack.mdx similarity index 100% rename from docs/api-reference/core/Unpack.mdx rename to docs/_deprecated/api-reference/core/Unpack.mdx diff --git a/docs/api-reference/core/Unwrappable.mdx b/docs/_deprecated/api-reference/core/Unwrappable.mdx similarity index 100% rename from docs/api-reference/core/Unwrappable.mdx rename to docs/_deprecated/api-reference/core/Unwrappable.mdx diff --git a/docs/api-reference/core/Usable.mdx b/docs/_deprecated/api-reference/core/Usable.mdx similarity index 100% rename from docs/api-reference/core/Usable.mdx rename to docs/_deprecated/api-reference/core/Usable.mdx diff --git a/docs/api-reference/core/Usage.mdx b/docs/_deprecated/api-reference/core/Usage.mdx similarity index 100% rename from docs/api-reference/core/Usage.mdx rename to docs/_deprecated/api-reference/core/Usage.mdx diff --git a/docs/api-reference/core/UsageKind.mdx b/docs/_deprecated/api-reference/core/UsageKind.mdx similarity index 100% rename from docs/api-reference/core/UsageKind.mdx rename to docs/_deprecated/api-reference/core/UsageKind.mdx diff --git a/docs/api-reference/core/UsageType.mdx b/docs/_deprecated/api-reference/core/UsageType.mdx similarity index 100% rename from docs/api-reference/core/UsageType.mdx rename to docs/_deprecated/api-reference/core/UsageType.mdx diff --git a/docs/api-reference/core/Value.mdx b/docs/_deprecated/api-reference/core/Value.mdx similarity index 100% rename from docs/api-reference/core/Value.mdx rename to docs/_deprecated/api-reference/core/Value.mdx diff --git a/docs/api-reference/core/WhileStatement.mdx b/docs/_deprecated/api-reference/core/WhileStatement.mdx similarity index 100% rename from docs/api-reference/core/WhileStatement.mdx rename to docs/_deprecated/api-reference/core/WhileStatement.mdx diff --git a/docs/api-reference/core/WithStatement.mdx b/docs/_deprecated/api-reference/core/WithStatement.mdx similarity index 100% rename from docs/api-reference/core/WithStatement.mdx rename to docs/_deprecated/api-reference/core/WithStatement.mdx diff --git a/docs/api-reference/index.mdx b/docs/_deprecated/api-reference/index.mdx similarity index 100% rename from docs/api-reference/index.mdx rename to docs/_deprecated/api-reference/index.mdx diff --git a/docs/api-reference/python/PyAssignment.mdx b/docs/_deprecated/api-reference/python/PyAssignment.mdx similarity index 100% rename from docs/api-reference/python/PyAssignment.mdx rename to docs/_deprecated/api-reference/python/PyAssignment.mdx diff --git a/docs/api-reference/python/PyAssignmentStatement.mdx b/docs/_deprecated/api-reference/python/PyAssignmentStatement.mdx similarity index 100% rename from docs/api-reference/python/PyAssignmentStatement.mdx rename to docs/_deprecated/api-reference/python/PyAssignmentStatement.mdx diff --git a/docs/api-reference/python/PyAttribute.mdx b/docs/_deprecated/api-reference/python/PyAttribute.mdx similarity index 100% rename from docs/api-reference/python/PyAttribute.mdx rename to docs/_deprecated/api-reference/python/PyAttribute.mdx diff --git a/docs/api-reference/python/PyBlockStatement.mdx b/docs/_deprecated/api-reference/python/PyBlockStatement.mdx similarity index 100% rename from docs/api-reference/python/PyBlockStatement.mdx rename to docs/_deprecated/api-reference/python/PyBlockStatement.mdx diff --git a/docs/api-reference/python/PyBreakStatement.mdx b/docs/_deprecated/api-reference/python/PyBreakStatement.mdx similarity index 100% rename from docs/api-reference/python/PyBreakStatement.mdx rename to docs/_deprecated/api-reference/python/PyBreakStatement.mdx diff --git a/docs/api-reference/python/PyCatchStatement.mdx b/docs/_deprecated/api-reference/python/PyCatchStatement.mdx similarity index 100% rename from docs/api-reference/python/PyCatchStatement.mdx rename to docs/_deprecated/api-reference/python/PyCatchStatement.mdx diff --git a/docs/api-reference/python/PyChainedAttribute.mdx b/docs/_deprecated/api-reference/python/PyChainedAttribute.mdx similarity index 100% rename from docs/api-reference/python/PyChainedAttribute.mdx rename to docs/_deprecated/api-reference/python/PyChainedAttribute.mdx diff --git a/docs/api-reference/python/PyClass.mdx b/docs/_deprecated/api-reference/python/PyClass.mdx similarity index 100% rename from docs/api-reference/python/PyClass.mdx rename to docs/_deprecated/api-reference/python/PyClass.mdx diff --git a/docs/api-reference/python/PyCodeBlock.mdx b/docs/_deprecated/api-reference/python/PyCodeBlock.mdx similarity index 100% rename from docs/api-reference/python/PyCodeBlock.mdx rename to docs/_deprecated/api-reference/python/PyCodeBlock.mdx diff --git a/docs/api-reference/python/PyComment.mdx b/docs/_deprecated/api-reference/python/PyComment.mdx similarity index 100% rename from docs/api-reference/python/PyComment.mdx rename to docs/_deprecated/api-reference/python/PyComment.mdx diff --git a/docs/api-reference/python/PyCommentGroup.mdx b/docs/_deprecated/api-reference/python/PyCommentGroup.mdx similarity index 100% rename from docs/api-reference/python/PyCommentGroup.mdx rename to docs/_deprecated/api-reference/python/PyCommentGroup.mdx diff --git a/docs/api-reference/python/PyCommentType.mdx b/docs/_deprecated/api-reference/python/PyCommentType.mdx similarity index 100% rename from docs/api-reference/python/PyCommentType.mdx rename to docs/_deprecated/api-reference/python/PyCommentType.mdx diff --git a/docs/api-reference/python/PyConditionalExpression.mdx b/docs/_deprecated/api-reference/python/PyConditionalExpression.mdx similarity index 100% rename from docs/api-reference/python/PyConditionalExpression.mdx rename to docs/_deprecated/api-reference/python/PyConditionalExpression.mdx diff --git a/docs/api-reference/python/PyDecorator.mdx b/docs/_deprecated/api-reference/python/PyDecorator.mdx similarity index 100% rename from docs/api-reference/python/PyDecorator.mdx rename to docs/_deprecated/api-reference/python/PyDecorator.mdx diff --git a/docs/api-reference/python/PyFile.mdx b/docs/_deprecated/api-reference/python/PyFile.mdx similarity index 100% rename from docs/api-reference/python/PyFile.mdx rename to docs/_deprecated/api-reference/python/PyFile.mdx diff --git a/docs/api-reference/python/PyForLoopStatement.mdx b/docs/_deprecated/api-reference/python/PyForLoopStatement.mdx similarity index 100% rename from docs/api-reference/python/PyForLoopStatement.mdx rename to docs/_deprecated/api-reference/python/PyForLoopStatement.mdx diff --git a/docs/api-reference/python/PyFunction.mdx b/docs/_deprecated/api-reference/python/PyFunction.mdx similarity index 100% rename from docs/api-reference/python/PyFunction.mdx rename to docs/_deprecated/api-reference/python/PyFunction.mdx diff --git a/docs/api-reference/python/PyGenericType.mdx b/docs/_deprecated/api-reference/python/PyGenericType.mdx similarity index 100% rename from docs/api-reference/python/PyGenericType.mdx rename to docs/_deprecated/api-reference/python/PyGenericType.mdx diff --git a/docs/api-reference/python/PyHasBlock.mdx b/docs/_deprecated/api-reference/python/PyHasBlock.mdx similarity index 100% rename from docs/api-reference/python/PyHasBlock.mdx rename to docs/_deprecated/api-reference/python/PyHasBlock.mdx diff --git a/docs/api-reference/python/PyIfBlockStatement.mdx b/docs/_deprecated/api-reference/python/PyIfBlockStatement.mdx similarity index 100% rename from docs/api-reference/python/PyIfBlockStatement.mdx rename to docs/_deprecated/api-reference/python/PyIfBlockStatement.mdx diff --git a/docs/api-reference/python/PyImport.mdx b/docs/_deprecated/api-reference/python/PyImport.mdx similarity index 100% rename from docs/api-reference/python/PyImport.mdx rename to docs/_deprecated/api-reference/python/PyImport.mdx diff --git a/docs/api-reference/python/PyImportStatement.mdx b/docs/_deprecated/api-reference/python/PyImportStatement.mdx similarity index 100% rename from docs/api-reference/python/PyImportStatement.mdx rename to docs/_deprecated/api-reference/python/PyImportStatement.mdx diff --git a/docs/api-reference/python/PyMatchCase.mdx b/docs/_deprecated/api-reference/python/PyMatchCase.mdx similarity index 100% rename from docs/api-reference/python/PyMatchCase.mdx rename to docs/_deprecated/api-reference/python/PyMatchCase.mdx diff --git a/docs/api-reference/python/PyMatchStatement.mdx b/docs/_deprecated/api-reference/python/PyMatchStatement.mdx similarity index 100% rename from docs/api-reference/python/PyMatchStatement.mdx rename to docs/_deprecated/api-reference/python/PyMatchStatement.mdx diff --git a/docs/api-reference/python/PyNamedType.mdx b/docs/_deprecated/api-reference/python/PyNamedType.mdx similarity index 100% rename from docs/api-reference/python/PyNamedType.mdx rename to docs/_deprecated/api-reference/python/PyNamedType.mdx diff --git a/docs/api-reference/python/PyParameter.mdx b/docs/_deprecated/api-reference/python/PyParameter.mdx similarity index 100% rename from docs/api-reference/python/PyParameter.mdx rename to docs/_deprecated/api-reference/python/PyParameter.mdx diff --git a/docs/api-reference/python/PyPassStatement.mdx b/docs/_deprecated/api-reference/python/PyPassStatement.mdx similarity index 100% rename from docs/api-reference/python/PyPassStatement.mdx rename to docs/_deprecated/api-reference/python/PyPassStatement.mdx diff --git a/docs/api-reference/python/PyReturnTypePlaceholder.mdx b/docs/_deprecated/api-reference/python/PyReturnTypePlaceholder.mdx similarity index 100% rename from docs/api-reference/python/PyReturnTypePlaceholder.mdx rename to docs/_deprecated/api-reference/python/PyReturnTypePlaceholder.mdx diff --git a/docs/api-reference/python/PyString.mdx b/docs/_deprecated/api-reference/python/PyString.mdx similarity index 100% rename from docs/api-reference/python/PyString.mdx rename to docs/_deprecated/api-reference/python/PyString.mdx diff --git a/docs/api-reference/python/PySymbol.mdx b/docs/_deprecated/api-reference/python/PySymbol.mdx similarity index 100% rename from docs/api-reference/python/PySymbol.mdx rename to docs/_deprecated/api-reference/python/PySymbol.mdx diff --git a/docs/api-reference/python/PyTryCatchStatement.mdx b/docs/_deprecated/api-reference/python/PyTryCatchStatement.mdx similarity index 100% rename from docs/api-reference/python/PyTryCatchStatement.mdx rename to docs/_deprecated/api-reference/python/PyTryCatchStatement.mdx diff --git a/docs/api-reference/python/PyUnionType.mdx b/docs/_deprecated/api-reference/python/PyUnionType.mdx similarity index 100% rename from docs/api-reference/python/PyUnionType.mdx rename to docs/_deprecated/api-reference/python/PyUnionType.mdx diff --git a/docs/api-reference/python/PyWhileStatement.mdx b/docs/_deprecated/api-reference/python/PyWhileStatement.mdx similarity index 100% rename from docs/api-reference/python/PyWhileStatement.mdx rename to docs/_deprecated/api-reference/python/PyWhileStatement.mdx diff --git a/docs/api-reference/typescript/JSXElement.mdx b/docs/_deprecated/api-reference/typescript/JSXElement.mdx similarity index 100% rename from docs/api-reference/typescript/JSXElement.mdx rename to docs/_deprecated/api-reference/typescript/JSXElement.mdx diff --git a/docs/api-reference/typescript/JSXExpression.mdx b/docs/_deprecated/api-reference/typescript/JSXExpression.mdx similarity index 100% rename from docs/api-reference/typescript/JSXExpression.mdx rename to docs/_deprecated/api-reference/typescript/JSXExpression.mdx diff --git a/docs/api-reference/typescript/JSXProp.mdx b/docs/_deprecated/api-reference/typescript/JSXProp.mdx similarity index 100% rename from docs/api-reference/typescript/JSXProp.mdx rename to docs/_deprecated/api-reference/typescript/JSXProp.mdx diff --git a/docs/api-reference/typescript/TSArrayType.mdx b/docs/_deprecated/api-reference/typescript/TSArrayType.mdx similarity index 100% rename from docs/api-reference/typescript/TSArrayType.mdx rename to docs/_deprecated/api-reference/typescript/TSArrayType.mdx diff --git a/docs/api-reference/typescript/TSAssignment.mdx b/docs/_deprecated/api-reference/typescript/TSAssignment.mdx similarity index 100% rename from docs/api-reference/typescript/TSAssignment.mdx rename to docs/_deprecated/api-reference/typescript/TSAssignment.mdx diff --git a/docs/api-reference/typescript/TSAssignmentStatement.mdx b/docs/_deprecated/api-reference/typescript/TSAssignmentStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSAssignmentStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSAssignmentStatement.mdx diff --git a/docs/api-reference/typescript/TSAttribute.mdx b/docs/_deprecated/api-reference/typescript/TSAttribute.mdx similarity index 100% rename from docs/api-reference/typescript/TSAttribute.mdx rename to docs/_deprecated/api-reference/typescript/TSAttribute.mdx diff --git a/docs/api-reference/typescript/TSBlockStatement.mdx b/docs/_deprecated/api-reference/typescript/TSBlockStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSBlockStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSBlockStatement.mdx diff --git a/docs/api-reference/typescript/TSCatchStatement.mdx b/docs/_deprecated/api-reference/typescript/TSCatchStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSCatchStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSCatchStatement.mdx diff --git a/docs/api-reference/typescript/TSChainedAttribute.mdx b/docs/_deprecated/api-reference/typescript/TSChainedAttribute.mdx similarity index 100% rename from docs/api-reference/typescript/TSChainedAttribute.mdx rename to docs/_deprecated/api-reference/typescript/TSChainedAttribute.mdx diff --git a/docs/api-reference/typescript/TSClass.mdx b/docs/_deprecated/api-reference/typescript/TSClass.mdx similarity index 100% rename from docs/api-reference/typescript/TSClass.mdx rename to docs/_deprecated/api-reference/typescript/TSClass.mdx diff --git a/docs/api-reference/typescript/TSCodeBlock.mdx b/docs/_deprecated/api-reference/typescript/TSCodeBlock.mdx similarity index 100% rename from docs/api-reference/typescript/TSCodeBlock.mdx rename to docs/_deprecated/api-reference/typescript/TSCodeBlock.mdx diff --git a/docs/api-reference/typescript/TSComment.mdx b/docs/_deprecated/api-reference/typescript/TSComment.mdx similarity index 100% rename from docs/api-reference/typescript/TSComment.mdx rename to docs/_deprecated/api-reference/typescript/TSComment.mdx diff --git a/docs/api-reference/typescript/TSCommentGroup.mdx b/docs/_deprecated/api-reference/typescript/TSCommentGroup.mdx similarity index 100% rename from docs/api-reference/typescript/TSCommentGroup.mdx rename to docs/_deprecated/api-reference/typescript/TSCommentGroup.mdx diff --git a/docs/api-reference/typescript/TSCommentType.mdx b/docs/_deprecated/api-reference/typescript/TSCommentType.mdx similarity index 100% rename from docs/api-reference/typescript/TSCommentType.mdx rename to docs/_deprecated/api-reference/typescript/TSCommentType.mdx diff --git a/docs/api-reference/typescript/TSConditionalType.mdx b/docs/_deprecated/api-reference/typescript/TSConditionalType.mdx similarity index 100% rename from docs/api-reference/typescript/TSConditionalType.mdx rename to docs/_deprecated/api-reference/typescript/TSConditionalType.mdx diff --git a/docs/api-reference/typescript/TSConfig.mdx b/docs/_deprecated/api-reference/typescript/TSConfig.mdx similarity index 100% rename from docs/api-reference/typescript/TSConfig.mdx rename to docs/_deprecated/api-reference/typescript/TSConfig.mdx diff --git a/docs/api-reference/typescript/TSDecorator.mdx b/docs/_deprecated/api-reference/typescript/TSDecorator.mdx similarity index 100% rename from docs/api-reference/typescript/TSDecorator.mdx rename to docs/_deprecated/api-reference/typescript/TSDecorator.mdx diff --git a/docs/api-reference/typescript/TSDict.mdx b/docs/_deprecated/api-reference/typescript/TSDict.mdx similarity index 100% rename from docs/api-reference/typescript/TSDict.mdx rename to docs/_deprecated/api-reference/typescript/TSDict.mdx diff --git a/docs/api-reference/typescript/TSEnum.mdx b/docs/_deprecated/api-reference/typescript/TSEnum.mdx similarity index 100% rename from docs/api-reference/typescript/TSEnum.mdx rename to docs/_deprecated/api-reference/typescript/TSEnum.mdx diff --git a/docs/api-reference/typescript/TSExport.mdx b/docs/_deprecated/api-reference/typescript/TSExport.mdx similarity index 100% rename from docs/api-reference/typescript/TSExport.mdx rename to docs/_deprecated/api-reference/typescript/TSExport.mdx diff --git a/docs/api-reference/typescript/TSExpressionType.mdx b/docs/_deprecated/api-reference/typescript/TSExpressionType.mdx similarity index 100% rename from docs/api-reference/typescript/TSExpressionType.mdx rename to docs/_deprecated/api-reference/typescript/TSExpressionType.mdx diff --git a/docs/api-reference/typescript/TSFile.mdx b/docs/_deprecated/api-reference/typescript/TSFile.mdx similarity index 100% rename from docs/api-reference/typescript/TSFile.mdx rename to docs/_deprecated/api-reference/typescript/TSFile.mdx diff --git a/docs/api-reference/typescript/TSForLoopStatement.mdx b/docs/_deprecated/api-reference/typescript/TSForLoopStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSForLoopStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSForLoopStatement.mdx diff --git a/docs/api-reference/typescript/TSFunction.mdx b/docs/_deprecated/api-reference/typescript/TSFunction.mdx similarity index 100% rename from docs/api-reference/typescript/TSFunction.mdx rename to docs/_deprecated/api-reference/typescript/TSFunction.mdx diff --git a/docs/api-reference/typescript/TSFunctionType.mdx b/docs/_deprecated/api-reference/typescript/TSFunctionType.mdx similarity index 100% rename from docs/api-reference/typescript/TSFunctionType.mdx rename to docs/_deprecated/api-reference/typescript/TSFunctionType.mdx diff --git a/docs/api-reference/typescript/TSGenericType.mdx b/docs/_deprecated/api-reference/typescript/TSGenericType.mdx similarity index 100% rename from docs/api-reference/typescript/TSGenericType.mdx rename to docs/_deprecated/api-reference/typescript/TSGenericType.mdx diff --git a/docs/api-reference/typescript/TSHasBlock.mdx b/docs/_deprecated/api-reference/typescript/TSHasBlock.mdx similarity index 100% rename from docs/api-reference/typescript/TSHasBlock.mdx rename to docs/_deprecated/api-reference/typescript/TSHasBlock.mdx diff --git a/docs/api-reference/typescript/TSIfBlockStatement.mdx b/docs/_deprecated/api-reference/typescript/TSIfBlockStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSIfBlockStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSIfBlockStatement.mdx diff --git a/docs/api-reference/typescript/TSImport.mdx b/docs/_deprecated/api-reference/typescript/TSImport.mdx similarity index 100% rename from docs/api-reference/typescript/TSImport.mdx rename to docs/_deprecated/api-reference/typescript/TSImport.mdx diff --git a/docs/api-reference/typescript/TSImportStatement.mdx b/docs/_deprecated/api-reference/typescript/TSImportStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSImportStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSImportStatement.mdx diff --git a/docs/api-reference/typescript/TSInterface.mdx b/docs/_deprecated/api-reference/typescript/TSInterface.mdx similarity index 100% rename from docs/api-reference/typescript/TSInterface.mdx rename to docs/_deprecated/api-reference/typescript/TSInterface.mdx diff --git a/docs/api-reference/typescript/TSLabeledStatement.mdx b/docs/_deprecated/api-reference/typescript/TSLabeledStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSLabeledStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSLabeledStatement.mdx diff --git a/docs/api-reference/typescript/TSLookupType.mdx b/docs/_deprecated/api-reference/typescript/TSLookupType.mdx similarity index 100% rename from docs/api-reference/typescript/TSLookupType.mdx rename to docs/_deprecated/api-reference/typescript/TSLookupType.mdx diff --git a/docs/api-reference/typescript/TSNamedType.mdx b/docs/_deprecated/api-reference/typescript/TSNamedType.mdx similarity index 100% rename from docs/api-reference/typescript/TSNamedType.mdx rename to docs/_deprecated/api-reference/typescript/TSNamedType.mdx diff --git a/docs/api-reference/typescript/TSNamespace.mdx b/docs/_deprecated/api-reference/typescript/TSNamespace.mdx similarity index 100% rename from docs/api-reference/typescript/TSNamespace.mdx rename to docs/_deprecated/api-reference/typescript/TSNamespace.mdx diff --git a/docs/api-reference/typescript/TSObjectType.mdx b/docs/_deprecated/api-reference/typescript/TSObjectType.mdx similarity index 100% rename from docs/api-reference/typescript/TSObjectType.mdx rename to docs/_deprecated/api-reference/typescript/TSObjectType.mdx diff --git a/docs/api-reference/typescript/TSPair.mdx b/docs/_deprecated/api-reference/typescript/TSPair.mdx similarity index 100% rename from docs/api-reference/typescript/TSPair.mdx rename to docs/_deprecated/api-reference/typescript/TSPair.mdx diff --git a/docs/api-reference/typescript/TSParameter.mdx b/docs/_deprecated/api-reference/typescript/TSParameter.mdx similarity index 100% rename from docs/api-reference/typescript/TSParameter.mdx rename to docs/_deprecated/api-reference/typescript/TSParameter.mdx diff --git a/docs/api-reference/typescript/TSQueryType.mdx b/docs/_deprecated/api-reference/typescript/TSQueryType.mdx similarity index 100% rename from docs/api-reference/typescript/TSQueryType.mdx rename to docs/_deprecated/api-reference/typescript/TSQueryType.mdx diff --git a/docs/api-reference/typescript/TSReadonlyType.mdx b/docs/_deprecated/api-reference/typescript/TSReadonlyType.mdx similarity index 100% rename from docs/api-reference/typescript/TSReadonlyType.mdx rename to docs/_deprecated/api-reference/typescript/TSReadonlyType.mdx diff --git a/docs/api-reference/typescript/TSReturnTypePlaceholder.mdx b/docs/_deprecated/api-reference/typescript/TSReturnTypePlaceholder.mdx similarity index 100% rename from docs/api-reference/typescript/TSReturnTypePlaceholder.mdx rename to docs/_deprecated/api-reference/typescript/TSReturnTypePlaceholder.mdx diff --git a/docs/api-reference/typescript/TSString.mdx b/docs/_deprecated/api-reference/typescript/TSString.mdx similarity index 100% rename from docs/api-reference/typescript/TSString.mdx rename to docs/_deprecated/api-reference/typescript/TSString.mdx diff --git a/docs/api-reference/typescript/TSSwitchCase.mdx b/docs/_deprecated/api-reference/typescript/TSSwitchCase.mdx similarity index 100% rename from docs/api-reference/typescript/TSSwitchCase.mdx rename to docs/_deprecated/api-reference/typescript/TSSwitchCase.mdx diff --git a/docs/api-reference/typescript/TSSwitchStatement.mdx b/docs/_deprecated/api-reference/typescript/TSSwitchStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSSwitchStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSSwitchStatement.mdx diff --git a/docs/api-reference/typescript/TSSymbol.mdx b/docs/_deprecated/api-reference/typescript/TSSymbol.mdx similarity index 100% rename from docs/api-reference/typescript/TSSymbol.mdx rename to docs/_deprecated/api-reference/typescript/TSSymbol.mdx diff --git a/docs/api-reference/typescript/TSTernaryExpression.mdx b/docs/_deprecated/api-reference/typescript/TSTernaryExpression.mdx similarity index 100% rename from docs/api-reference/typescript/TSTernaryExpression.mdx rename to docs/_deprecated/api-reference/typescript/TSTernaryExpression.mdx diff --git a/docs/api-reference/typescript/TSTryCatchStatement.mdx b/docs/_deprecated/api-reference/typescript/TSTryCatchStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSTryCatchStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSTryCatchStatement.mdx diff --git a/docs/api-reference/typescript/TSTypeAlias.mdx b/docs/_deprecated/api-reference/typescript/TSTypeAlias.mdx similarity index 100% rename from docs/api-reference/typescript/TSTypeAlias.mdx rename to docs/_deprecated/api-reference/typescript/TSTypeAlias.mdx diff --git a/docs/api-reference/typescript/TSUndefinedType.mdx b/docs/_deprecated/api-reference/typescript/TSUndefinedType.mdx similarity index 100% rename from docs/api-reference/typescript/TSUndefinedType.mdx rename to docs/_deprecated/api-reference/typescript/TSUndefinedType.mdx diff --git a/docs/api-reference/typescript/TSUnionType.mdx b/docs/_deprecated/api-reference/typescript/TSUnionType.mdx similarity index 100% rename from docs/api-reference/typescript/TSUnionType.mdx rename to docs/_deprecated/api-reference/typescript/TSUnionType.mdx diff --git a/docs/api-reference/typescript/TSWhileStatement.mdx b/docs/_deprecated/api-reference/typescript/TSWhileStatement.mdx similarity index 100% rename from docs/api-reference/typescript/TSWhileStatement.mdx rename to docs/_deprecated/api-reference/typescript/TSWhileStatement.mdx diff --git a/docs/building-with-codegen/at-a-glance.mdx b/docs/_deprecated/building-with-codegen/at-a-glance.mdx similarity index 100% rename from docs/building-with-codegen/at-a-glance.mdx rename to docs/_deprecated/building-with-codegen/at-a-glance.mdx diff --git a/docs/building-with-codegen/calling-out-to-llms.mdx b/docs/_deprecated/building-with-codegen/calling-out-to-llms.mdx similarity index 100% rename from docs/building-with-codegen/calling-out-to-llms.mdx rename to docs/_deprecated/building-with-codegen/calling-out-to-llms.mdx diff --git a/docs/building-with-codegen/class-api.mdx b/docs/_deprecated/building-with-codegen/class-api.mdx similarity index 100% rename from docs/building-with-codegen/class-api.mdx rename to docs/_deprecated/building-with-codegen/class-api.mdx diff --git a/docs/building-with-codegen/codebase-visualization.mdx b/docs/_deprecated/building-with-codegen/codebase-visualization.mdx similarity index 100% rename from docs/building-with-codegen/codebase-visualization.mdx rename to docs/_deprecated/building-with-codegen/codebase-visualization.mdx diff --git a/docs/building-with-codegen/codegen-with-wsl.mdx b/docs/_deprecated/building-with-codegen/codegen-with-wsl.mdx similarity index 100% rename from docs/building-with-codegen/codegen-with-wsl.mdx rename to docs/_deprecated/building-with-codegen/codegen-with-wsl.mdx diff --git a/docs/building-with-codegen/collections.mdx b/docs/_deprecated/building-with-codegen/collections.mdx similarity index 100% rename from docs/building-with-codegen/collections.mdx rename to docs/_deprecated/building-with-codegen/collections.mdx diff --git a/docs/building-with-codegen/comments-and-docstrings.mdx b/docs/_deprecated/building-with-codegen/comments-and-docstrings.mdx similarity index 100% rename from docs/building-with-codegen/comments-and-docstrings.mdx rename to docs/_deprecated/building-with-codegen/comments-and-docstrings.mdx diff --git a/docs/building-with-codegen/commit-and-reset.mdx b/docs/_deprecated/building-with-codegen/commit-and-reset.mdx similarity index 100% rename from docs/building-with-codegen/commit-and-reset.mdx rename to docs/_deprecated/building-with-codegen/commit-and-reset.mdx diff --git a/docs/building-with-codegen/dependencies-and-usages.mdx b/docs/_deprecated/building-with-codegen/dependencies-and-usages.mdx similarity index 100% rename from docs/building-with-codegen/dependencies-and-usages.mdx rename to docs/_deprecated/building-with-codegen/dependencies-and-usages.mdx diff --git a/docs/building-with-codegen/dot-codegen.mdx b/docs/_deprecated/building-with-codegen/dot-codegen.mdx similarity index 100% rename from docs/building-with-codegen/dot-codegen.mdx rename to docs/_deprecated/building-with-codegen/dot-codegen.mdx diff --git a/docs/building-with-codegen/editables-and-behaviors.mdx b/docs/_deprecated/building-with-codegen/editables-and-behaviors.mdx similarity index 100% rename from docs/building-with-codegen/editables-and-behaviors.mdx rename to docs/_deprecated/building-with-codegen/editables-and-behaviors.mdx diff --git a/docs/building-with-codegen/exports.mdx b/docs/_deprecated/building-with-codegen/exports.mdx similarity index 100% rename from docs/building-with-codegen/exports.mdx rename to docs/_deprecated/building-with-codegen/exports.mdx diff --git a/docs/building-with-codegen/external-modules.mdx b/docs/_deprecated/building-with-codegen/external-modules.mdx similarity index 100% rename from docs/building-with-codegen/external-modules.mdx rename to docs/_deprecated/building-with-codegen/external-modules.mdx diff --git a/docs/building-with-codegen/files-and-directories.mdx b/docs/_deprecated/building-with-codegen/files-and-directories.mdx similarity index 100% rename from docs/building-with-codegen/files-and-directories.mdx rename to docs/_deprecated/building-with-codegen/files-and-directories.mdx diff --git a/docs/building-with-codegen/flagging-symbols.mdx b/docs/_deprecated/building-with-codegen/flagging-symbols.mdx similarity index 100% rename from docs/building-with-codegen/flagging-symbols.mdx rename to docs/_deprecated/building-with-codegen/flagging-symbols.mdx diff --git a/docs/building-with-codegen/function-calls-and-callsites.mdx b/docs/_deprecated/building-with-codegen/function-calls-and-callsites.mdx similarity index 100% rename from docs/building-with-codegen/function-calls-and-callsites.mdx rename to docs/_deprecated/building-with-codegen/function-calls-and-callsites.mdx diff --git a/docs/building-with-codegen/function-decorator.mdx b/docs/_deprecated/building-with-codegen/function-decorator.mdx similarity index 100% rename from docs/building-with-codegen/function-decorator.mdx rename to docs/_deprecated/building-with-codegen/function-decorator.mdx diff --git a/docs/building-with-codegen/git-operations.mdx b/docs/_deprecated/building-with-codegen/git-operations.mdx similarity index 100% rename from docs/building-with-codegen/git-operations.mdx rename to docs/_deprecated/building-with-codegen/git-operations.mdx diff --git a/docs/building-with-codegen/imports.mdx b/docs/_deprecated/building-with-codegen/imports.mdx similarity index 100% rename from docs/building-with-codegen/imports.mdx rename to docs/_deprecated/building-with-codegen/imports.mdx diff --git a/docs/building-with-codegen/inheritable-behaviors.mdx b/docs/_deprecated/building-with-codegen/inheritable-behaviors.mdx similarity index 100% rename from docs/building-with-codegen/inheritable-behaviors.mdx rename to docs/_deprecated/building-with-codegen/inheritable-behaviors.mdx diff --git a/docs/building-with-codegen/language-support.mdx b/docs/_deprecated/building-with-codegen/language-support.mdx similarity index 100% rename from docs/building-with-codegen/language-support.mdx rename to docs/_deprecated/building-with-codegen/language-support.mdx diff --git a/docs/building-with-codegen/local-variables.mdx b/docs/_deprecated/building-with-codegen/local-variables.mdx similarity index 100% rename from docs/building-with-codegen/local-variables.mdx rename to docs/_deprecated/building-with-codegen/local-variables.mdx diff --git a/docs/building-with-codegen/moving-symbols.mdx b/docs/_deprecated/building-with-codegen/moving-symbols.mdx similarity index 100% rename from docs/building-with-codegen/moving-symbols.mdx rename to docs/_deprecated/building-with-codegen/moving-symbols.mdx diff --git a/docs/building-with-codegen/parsing-codebases.mdx b/docs/_deprecated/building-with-codegen/parsing-codebases.mdx similarity index 100% rename from docs/building-with-codegen/parsing-codebases.mdx rename to docs/_deprecated/building-with-codegen/parsing-codebases.mdx diff --git a/docs/building-with-codegen/react-and-jsx.mdx b/docs/_deprecated/building-with-codegen/react-and-jsx.mdx similarity index 100% rename from docs/building-with-codegen/react-and-jsx.mdx rename to docs/_deprecated/building-with-codegen/react-and-jsx.mdx diff --git a/docs/building-with-codegen/reducing-conditions.mdx b/docs/_deprecated/building-with-codegen/reducing-conditions.mdx similarity index 100% rename from docs/building-with-codegen/reducing-conditions.mdx rename to docs/_deprecated/building-with-codegen/reducing-conditions.mdx diff --git a/docs/building-with-codegen/reusable-codemods.mdx b/docs/_deprecated/building-with-codegen/reusable-codemods.mdx similarity index 100% rename from docs/building-with-codegen/reusable-codemods.mdx rename to docs/_deprecated/building-with-codegen/reusable-codemods.mdx diff --git a/docs/building-with-codegen/semantic-code-search.mdx b/docs/_deprecated/building-with-codegen/semantic-code-search.mdx similarity index 100% rename from docs/building-with-codegen/semantic-code-search.mdx rename to docs/_deprecated/building-with-codegen/semantic-code-search.mdx diff --git a/docs/building-with-codegen/statements-and-code-blocks.mdx b/docs/_deprecated/building-with-codegen/statements-and-code-blocks.mdx similarity index 100% rename from docs/building-with-codegen/statements-and-code-blocks.mdx rename to docs/_deprecated/building-with-codegen/statements-and-code-blocks.mdx diff --git a/docs/building-with-codegen/symbol-api.mdx b/docs/_deprecated/building-with-codegen/symbol-api.mdx similarity index 100% rename from docs/building-with-codegen/symbol-api.mdx rename to docs/_deprecated/building-with-codegen/symbol-api.mdx diff --git a/docs/building-with-codegen/the-editable-api.mdx b/docs/_deprecated/building-with-codegen/the-editable-api.mdx similarity index 100% rename from docs/building-with-codegen/the-editable-api.mdx rename to docs/_deprecated/building-with-codegen/the-editable-api.mdx diff --git a/docs/building-with-codegen/traversing-the-call-graph.mdx b/docs/_deprecated/building-with-codegen/traversing-the-call-graph.mdx similarity index 100% rename from docs/building-with-codegen/traversing-the-call-graph.mdx rename to docs/_deprecated/building-with-codegen/traversing-the-call-graph.mdx diff --git a/docs/building-with-codegen/type-annotations.mdx b/docs/_deprecated/building-with-codegen/type-annotations.mdx similarity index 100% rename from docs/building-with-codegen/type-annotations.mdx rename to docs/_deprecated/building-with-codegen/type-annotations.mdx diff --git a/docs/building-with-codegen/variable-assignments.mdx b/docs/_deprecated/building-with-codegen/variable-assignments.mdx similarity index 100% rename from docs/building-with-codegen/variable-assignments.mdx rename to docs/_deprecated/building-with-codegen/variable-assignments.mdx diff --git a/docs/cli/about.mdx b/docs/_deprecated/cli/about.mdx similarity index 100% rename from docs/cli/about.mdx rename to docs/_deprecated/cli/about.mdx diff --git a/docs/cli/create.mdx b/docs/_deprecated/cli/create.mdx similarity index 100% rename from docs/cli/create.mdx rename to docs/_deprecated/cli/create.mdx diff --git a/docs/cli/expert.mdx b/docs/_deprecated/cli/expert.mdx similarity index 100% rename from docs/cli/expert.mdx rename to docs/_deprecated/cli/expert.mdx diff --git a/docs/cli/init.mdx b/docs/_deprecated/cli/init.mdx similarity index 100% rename from docs/cli/init.mdx rename to docs/_deprecated/cli/init.mdx diff --git a/docs/cli/login.mdx b/docs/_deprecated/cli/login.mdx similarity index 100% rename from docs/cli/login.mdx rename to docs/_deprecated/cli/login.mdx diff --git a/docs/cli/notebook.mdx b/docs/_deprecated/cli/notebook.mdx similarity index 100% rename from docs/cli/notebook.mdx rename to docs/_deprecated/cli/notebook.mdx diff --git a/docs/cli/reset.mdx b/docs/_deprecated/cli/reset.mdx similarity index 100% rename from docs/cli/reset.mdx rename to docs/_deprecated/cli/reset.mdx diff --git a/docs/cli/run.mdx b/docs/_deprecated/cli/run.mdx similarity index 100% rename from docs/cli/run.mdx rename to docs/_deprecated/cli/run.mdx diff --git a/docs/cli/update.mdx b/docs/_deprecated/cli/update.mdx similarity index 100% rename from docs/cli/update.mdx rename to docs/_deprecated/cli/update.mdx diff --git a/docs/_deprecated/graph-sitter/about.mdx b/docs/_deprecated/graph-sitter/about.mdx new file mode 100644 index 000000000..d7ffe80a1 --- /dev/null +++ b/docs/_deprecated/graph-sitter/about.mdx @@ -0,0 +1,72 @@ +--- +title: "Codegen, Inc." +sidebarTitle: "About Us" +icon: "building" +iconType: "solid" +--- + + + +## Our Mission + +Our mission is to build fully-autonomous software engineering - the equivalent of self-driving cars for code. + +We believe the highest leverage path to autonomous development is enabling AI agents to "act via code." + +Just as self-driving cars need sophisticated sensors and controls to navigate the physical world, AI agents need powerful, precise tools to manipulate codebases. We're building that foundational layer: a programmatic interface that lets AI agents express complex code transformations through code itself. + +This approach creates a shared language that both humans and AI can use to: + +- Express powerful changes with precision and predictability +- Build sophisticated tools from primitive operations +- Create and maintain their own abstractions +- Scale transformations across massive codebases + +## The Team + +Based in San Francisco, we're a team of engineers and researchers passionate about: + +- Making large-scale code changes more accessible +- Building tools that work the way developers think +- Creating the infrastructure for AI-powered code manipulation +- Advancing the state of the art in program transformation + +## Open Source + +We believe in the power of open source software. Our core library, [codegen](https://github.com/codegen-sh/codegen-sdk), is freely available and open to contributions from the community. + +## Join Us + + + + We're hiring! Join us in building the future of code transformation. + + + Connect with other developers and share your Codegen experiences. + + + +## Connect with Us + + + + Follow us for updates and announcements + + + Connect with our team and stay updated on company news + + + + + Want to learn more about what we're building? Check out our [getting started + guide](/introduction/getting-started) or join our [community + Slack](https://community.codegen.com). + diff --git a/docs/introduction/advanced-settings.mdx b/docs/_deprecated/graph-sitter/advanced-settings.mdx similarity index 100% rename from docs/introduction/advanced-settings.mdx rename to docs/_deprecated/graph-sitter/advanced-settings.mdx diff --git a/docs/_deprecated/graph-sitter/community.mdx b/docs/_deprecated/graph-sitter/community.mdx new file mode 100644 index 000000000..ed02a4276 --- /dev/null +++ b/docs/_deprecated/graph-sitter/community.mdx @@ -0,0 +1,48 @@ +--- +title: "Community & Contributing" +sidebarTitle: "Community" +icon: "people-group" +iconType: "solid" +--- + +import { + COMMUNITY_SLACK_URL, + CODEGEN_SDK_GITHUB_URL, +} from "/snippets/links.mdx"; + +Join the growing Codegen community! We're excited to have you be part of our journey to make codebase manipulation and transformation more accessible. + + + + Connect with the community, get help, and share your Codegen projects in our + active Slack workspace. + + + Star us on GitHub, report issues, submit PRs, and contribute to the project. + + + Follow us for updates, tips, and community highlights. + + + Learn how to use Codegen effectively with our comprehensive guides. + + + + + Please help us improve this library and documentation by submitting a PR! + + +## Contributing + +We welcome contributions of all kinds! Whether you're fixing a typo in documentation, reporting a bug, or implementing a new feature, we appreciate your help in making Codegen better. + +Check out our [Contributing Guide](https://github.com/codegen-sh/codegen-sdk/blob/develop/CONTRIBUTING.md) on GitHub to learn how to: + +- Set up your development environment +- Submit pull requests +- Report issues +- Contribute to documentation diff --git a/docs/_deprecated/graph-sitter/faq.mdx b/docs/_deprecated/graph-sitter/faq.mdx new file mode 100644 index 000000000..d7f3abfba --- /dev/null +++ b/docs/_deprecated/graph-sitter/faq.mdx @@ -0,0 +1,58 @@ +--- +title: "Frequently Asked Questions" +sidebarTitle: "FAQ" +icon: "square-question" +iconType: "solid" +--- + + + + Codegen currently parses two languages: + - [Python](/api-reference/python) + - [TypeScript](/api-reference/typescript) + + We're actively working on expanding language support based on community needs. + + Learn more about how Codegen handles language specifics in the [Language + Support](/building-with-codegen/language-support) guide. + + + Interested in adding support for your language? [Let us know](https://x.com/codegen) or [contribute](/introduction/community)! + + + + + Pretty much! Codegen is roughly on par with `mypy` and `tsc`. There are always edge cases in static analysis that are provably impossible to get (for example doing `eval()` on a string), but all of Codegen's APIs are intended to be exact unless otherwise specified. Please reach out if you find an edge case and we will do our best to patch it. + + + Yes! Codegen was developed on multmillion-line Python and Typescript codebases + and includes optimizations for handling large-scale transformations. + + For enterprise support, please reach out to [team@codegen.com](mailto:team@codegen.com) + + + + Yes - [by design](/introduction/guiding-principles#python-first-composability). + + Codegen works like any other python package. It works alongside your IDE, version control system, and other development tools. + + + Start by trying out Codegen, joining our [Slack community](https://community.codegen.com), and looking for + issues labeled "good first issue" on [GitHub](https://github.com/codegen-sh/codegen-sdk). We welcome contributions to + documentation, examples, and code improvements. + + + Yes, Codegen is [open source](https://github.com/codegen-sh/codegen-sdk) and free to use under the [Apache 2.0 + license](https://github.com/codegen-sh/codegen-sdk?tab=Apache-2.0-1-ov-file). + You can use it for both personal and commercial projects. + + + The best places to get help are: + 1. Our community [Slack channel](https://community.codegen.com) + 2. [GitHub issues](https://github.com/codegen-sh/codegen-sdk) for bug reports + 3. Reach out to us on [Twitter](https://x.com/codegen) + + diff --git a/docs/_deprecated/graph-sitter/getting-started.mdx b/docs/_deprecated/graph-sitter/getting-started.mdx new file mode 100644 index 000000000..ad9e2c5f2 --- /dev/null +++ b/docs/_deprecated/graph-sitter/getting-started.mdx @@ -0,0 +1,342 @@ +--- +title: "Getting Started" +sidebarTitle: "Getting Started" +icon: "bolt" +iconType: "solid" +--- + +A quick tour of Codegen in a Jupyter notebook. + +## Installation + +Install [codegen](https://pypi.org/project/codegen/) on Pypi via [uv](https://github.com/astral-sh/uv): + +```bash +uv tool install codegen +``` + +## Quick Start with Jupyter + +The [codegen notebook](/cli/notebook) command creates a virtual environment and opens a Jupyter notebook for quick prototyping. This is often the fastest way to get up and running. + +```bash +# Launch Jupyter with a demo notebook +codegen notebook --demo +``` + + + + The `notebook --demo` comes pre-configured to load [FastAPI](https://github.com/fastapi/fastapi)'s codebase, so you can start + exploring right away! + + + + Prefer working in your IDE? See [IDE Usage](/introduction/ide-usage) + + +## Initializing a Codebase + +Instantiating a [Codebase](/api-reference/core/Codebase) will automatically parse a codebase and make it available for manipulation. + +```python +from codegen import Codebase + +# Clone + parse fastapi/fastapi +codebase = Codebase.from_repo('fastapi/fastapi') + +# Or, parse a local repository +codebase = Codebase("path/to/git/repo") +``` + + + This will automatically infer the programming language of the codebase and + parse all files in the codebase. Learn more about [parsing codebases here](/building-with-codegen/parsing-codebases) + + +## Exploring Your Codebase + +Let's explore the codebase we just initialized. + +Here are some common patterns for code navigation in Codegen: + +- Iterate over all [Functions](/api-reference/core/Function) with [Codebase.functions](/api-reference/core/Codebase#functions) +- View class inheritance with [Class.superclasses](/api-reference/core/Class#superclasses) +- View function usages with [Function.usages](/api-reference/core/Function#usages) +- View inheritance hierarchies with [inheritance APIs](https://docs.codegen.com/building-with-codegen/class-api#working-with-inheritance) +- Identify recursive functions by looking at [FunctionCalls](https://docs.codegen.com/building-with-codegen/function-calls-and-callsites) +- View function call-sites with [Function.call_sites](/api-reference/core/Function#call-sites) + +```python +# Print overall stats +print("πŸ” Codebase Analysis") +print("=" * 50) +print(f"πŸ“š Total Classes: {len(codebase.classes)}") +print(f"⚑ Total Functions: {len(codebase.functions)}") +print(f"πŸ”„ Total Imports: {len(codebase.imports)}") + +# Find class with most inheritance +if codebase.classes: + deepest_class = max(codebase.classes, key=lambda x: len(x.superclasses)) + print(f"\n🌳 Class with most inheritance: {deepest_class.name}") + print(f" πŸ“Š Chain Depth: {len(deepest_class.superclasses)}") + print(f" ⛓️ Chain: {' -> '.join(s.name for s in deepest_class.superclasses)}") + +# Find first 5 recursive functions +recursive = [f for f in codebase.functions + if any(call.name == f.name for call in f.function_calls)][:5] +if recursive: + print(f"\nπŸ”„ Recursive functions:") + for func in recursive: + print(f" - {func.name}") +``` + +## Analyzing Tests + +Let's specifically drill into large test files, which can be cumbersome to manage. + +```python +from collections import Counter + +# Filter to all test functions and classes +test_functions = [x for x in codebase.functions if x.name.startswith('test_')] +test_classes = [x for x in codebase.classes if x.name.startswith('Test')] + +print("πŸ§ͺ Test Analysis") +print("=" * 50) +print(f"πŸ“ Total Test Functions: {len(test_functions)}") +print(f"πŸ”¬ Total Test Classes: {len(test_classes)}") +print(f"πŸ“Š Tests per File: {len(test_functions) / len(codebase.files):.1f}") + +# Find files with the most tests +print("\nπŸ“š Top Test Files by Class Count") +print("-" * 50) +file_test_counts = Counter([x.file for x in test_classes]) +for file, num_tests in file_test_counts.most_common()[:5]: + print(f"πŸ” {num_tests} test classes: {file.filepath}") + print(f" πŸ“ File Length: {len(file.source)} lines") + print(f" πŸ’‘ Functions: {len(file.functions)}") +``` + +## Splitting Up Large Test Files + +Lets split up the largest test files into separate modules for better organization. + +This uses Codegen's [codebase.move_to_file(...)](/building-with-codegen/moving-symbols), which will: +- update all imports +- (optionally) move dependencies +- do so very fast ⚑️ + +While maintaining correctness. + +```python +filename = 'tests/test_path.py' +print(f"πŸ“¦ Splitting Test File: {filename}") +print("=" * 50) + +# Grab a file +file = codebase.get_file(filename) +base_name = filename.replace('.py', '') + +# Group tests by subpath +test_groups = {} +for test_function in file.functions: + if test_function.name.startswith('test_'): + test_subpath = '_'.join(test_function.name.split('_')[:3]) + if test_subpath not in test_groups: + test_groups[test_subpath] = [] + test_groups[test_subpath].append(test_function) + +# Print and process each group +for subpath, tests in test_groups.items(): + print(f"\\n{subpath}/") + new_filename = f"{base_name}/{subpath}.py" + + # Create file if it doesn't exist + if not codebase.has_file(new_filename): + new_file = codebase.create_file(new_filename) + file = codebase.get_file(new_filename) + + # Move each test in the group + for test_function in tests: + print(f" - {test_function.name}") + test_function.move_to_file(new_file, strategy="add_back_edge") + +# Commit changes to disk +codebase.commit() +``` + + + In order to commit changes to your filesystem, you must call + [codebase.commit()](/api-reference/core/Codebase#commit). Learn more about + [commit() and reset()](/building-with-codegen/commit-and-reset). + + +### Finding Specific Content + +Once you have a general sense of your codebase, you can filter down to exactly what you're looking for. Codegen's graph structure makes it straightforward and performant to find and traverse specific code elements: + +```python +# Grab specific content by name +my_resource = codebase.get_symbol('TestResource') + +# Find classes that inherit from a specific base +resource_classes = [ + cls for cls in codebase.classes + if cls.is_subclass_of('Resource') +] + +# Find functions with specific decorators +test_functions = [ + f for f in codebase.functions + if any('pytest' in d.source for d in f.decorators) +] + +# Find files matching certain patterns +test_files = [ + f for f in codebase.files + if f.name.startswith('test_') +] +``` + +## Safe Code Transformations + +Codegen guarantees that code transformations maintain correctness. It automatically handles updating imports, references, and dependencies. Here are some common transformations: + +```python +# Move all Enum classes to a dedicated file +for cls in codebase.classes: + if cls.is_subclass_of('Enum'): + # Codegen automatically: + # - Updates all imports that reference this class + # - Maintains the class's dependencies + # - Preserves comments and decorators + # - Generally performs this in a sane manner + cls.move_to_file(f'enums.py') + +# Rename a function and all its usages +old_function = codebase.get_function('process_data') +old_function.rename('process_resource') # Updates all references automatically + +# Change a function's signature +handler = codebase.get_function('event_handler') +handler.get_parameter('e').rename('event') # Automatically updates all call-sites +handler.add_parameter('timeout: int = 30') # Handles formatting and edge cases +handler.add_return_type('Response | None') + +# Perform surgery on call-sites +for fcall in handler.call_sites: + arg = fcall.get_arg_by_parameter_name('env') + # f(..., env={ data: x }) => f(..., env={ data: x or None }) + if isinstance(arg.value, Collection): + data_key = arg.value.get('data') + data_key.value.edit(f'{data_key.value} or None') +``` + + + When moving symbols, Codegen will automatically update all imports and + references. See [Moving Symbols](/building-with-codegen/moving-symbols) to + learn more. + + +## Leveraging Graph Relations + +Codegen's graph structure makes it easy to analyze relationships between code elements across files: + +```python +# Find dead code +for func in codebase.functions: + if len(func.usages) == 0: + print(f'πŸ—‘οΈ Dead code: {func.name}') + func.remove() + +# Analyze import relationships +file = codebase.get_file('api/endpoints.py') +print("\nFiles that import endpoints.py:") +for import_stmt in file.inbound_imports: + print(f" {import_stmt.file.path}") + +print("\nFiles that endpoints.py imports:") +for import_stmt in file.imports: + if import_stmt.resolved_symbol: + print(f" {import_stmt.resolved_symbol.file.path}") + +# Explore class hierarchies +base_class = codebase.get_class('BaseModel') +if base_class: + print(f"\nClasses that inherit from {base_class.name}:") + for subclass in base_class.subclasses: + print(f" {subclass.name}") + # We can go deeper in the inheritance tree + for sub_subclass in subclass.subclasses: + print(f" └─ {sub_subclass.name}") +``` + + + Learn more about [dependencies and + references](/building-with-codegen/dependencies-and-usages) or [imports](/building-with-codegen/imports) and [exports](/building-with-codegen/exports). + + +## Advanced Settings + +Codegen also supports a number of advanced settings that can be used to customize the behavior of the graph construction process. + +These flags are helpful for debugging problematic repos, optimizing Codegen’s performance, or testing unreleased or experimental (potentially backwards-breaking) features. + +```python +from codegen import Codebase +from codegen.configs import CodebaseConfig + +# Initialize a Codebase with custom configuration +codebase = Codebase( + "path/to/git/repo"", + config=CodebaseConfig( + verify_graph=True, + method_usages=False, + sync_enabled=True, + generics=False, + import_resolution_overrides={ + "old_module": "new_module" + }, + ts_language_engine=True, + v8_ts_engine=True + ) +) +``` + +To learn more about available settings, see the [Advanced Settings](/introduction/advanced-settings) page. + + +These are considered experimental and unstable features that may be removed or changed in the future. + + +## What's Next? + + + + Follow step-by-step tutorials for common code transformation tasks like + modernizing React codebases or migrating APIs. + + + Understand key concepts like working with files, functions, imports, and the + call graph to effectively manipulate code. + + + Iterate locally with your favorite IDE, work with a debugger and build sophisticated codemods + + + Learn how to use Codegen with Cursor, Devin, Windsurf, and more. + + + diff --git a/docs/_deprecated/graph-sitter/guiding-principles.mdx b/docs/_deprecated/graph-sitter/guiding-principles.mdx new file mode 100644 index 000000000..53201e5c1 --- /dev/null +++ b/docs/_deprecated/graph-sitter/guiding-principles.mdx @@ -0,0 +1,75 @@ +--- +title: "Guiding Principles" +sidebarTitle: "Principles" +icon: "compass" +iconType: "solid" +--- + +Codegen was developed by working backwards from real-world, large-scale codebase migrations. Instead of starting with abstract syntax trees and parser theory, we started with the question: "How do developers actually think about code changes?" + +This practical origin led to four core principles that shape Codegen's design: + +## Intuitive APIs + +Write code that reads like natural language, without worrying about abstract syntax trees or parser internals. Codegen provides high-level APIs that map directly to the transformations developers want to perform: + +```python +# Methods that read like English +function.rename("new_name") # Not ast.update_node(function_node, "name", "new_name") +function.move_to_file("new_file.py") # Not ast.relocate_node(function_node, "new_file.py") + +# Clean, readable properties +if function.is_async: # Not ast.get_node_attribute(function_node, "async") + print(function.name) # Not ast.get_node_name(function_node) + +# Natural iteration patterns +for usage in function.usages: # Not ast.find_references(function_node) + print(f"Used in {usage.file.name}") +``` + +## No Sharp Edges + +Focus on your high-level intent while Codegen handles the intricate details. + +Codegen operations handle the edge cases - it should be hard to break lint. + +```python +# Moving a function? Codegen handles: +function.move_to_file("new_file.py") +# βœ“ Updating all import statements +# βœ“ Preserving dependencies +# βœ“ Maintaining references +# βœ“ Fixing relative imports +# βœ“ Resolving naming conflicts + +# Renaming a symbol? Codegen manages: +class_def.rename("NewName") +# βœ“ Updating all usages +# βœ“ Handling string references +# βœ“ Preserving docstrings +# βœ“ Maintaining inheritance +``` + +## Performance through Pre-Computation + +Codegen frontloads as much as possible to enable fast, efficient transformations. + +It is built with the insight that each codebase only needs to be parsed once per commit. + + + Learn more about parsing the codebase graph in the [How it + Works](/introduction/how-it-works) guide. + + +## Python-First Composability + +Codegen embraces Python's strength as a "glue language" - its ability to seamlessly integrate different tools and APIs. This makes it natural to compose Codegen with your existing toolchain: + +- Build complex transforms by combining simpler operations +- Integrate Codegen with your existing tools (linters, type checkers, test frameworks, AI tools) + + + Python's rich ecosystem makes it ideal for code manipulation tasks. Codegen is + designed to be one tool in your toolbox, not a replacement for your entire + workflow. + diff --git a/docs/_deprecated/graph-sitter/how-it-works.mdx b/docs/_deprecated/graph-sitter/how-it-works.mdx new file mode 100644 index 000000000..8777a5be4 --- /dev/null +++ b/docs/_deprecated/graph-sitter/how-it-works.mdx @@ -0,0 +1,89 @@ +--- +title: "Under the Hood" +sidebarTitle: "How it Works" +icon: "gear" +iconType: "solid" +subtitle: "How Codegen's codebase graph works" +--- + +Codegen performs advanced static analysis to build a rich graph representation of your codebase. This pre-computation step analyzes dependencies, references, types, and control flow to enable fast and reliable code manipulation operations. + + + Codegen is built on top of + [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and + [rustworkx](https://github.com/Qiskit/rustworkx) and has implemented most + language server features from scratch. + + + Codegen is open source. Check out the [source + code](https://github.com/codegen-sh/codegen-sdk) to learn more! + + +## The Codebase Graph + +At the heart of Codegen is a comprehensive graph representation of your code. When you initialize a [Codebase](/api-reference/core/Codebase), it performs static analysis to construct a rich graph structure connecting code elements: + +```python +# Initialize and analyze the codebase +from codegen import Codebase +codebase = Codebase("./") + +# Access pre-computed relationships +function = codebase.get_symbol("process_data") +print(f"Dependencies: {function.dependencies}") # Instant lookup +print(f"Usages: {function.usages}") # No parsing needed +``` + +### Building the Graph + +Codegen's graph construction happens in two stages: + +1. **AST Parsing**: We use [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) as our foundation for parsing code into Abstract Syntax Trees. Tree-sitter provides fast, reliable parsing across multiple languages. + +2. **Multi-file Graph Construction**: Custom parsing logic, implemented in [rustworkx](https://github.com/Qiskit/rustworkx) and Python, analyzes these ASTs to construct a more sophisticated graph structure. This graph captures relationships between [symbols](/building-with-codegen/symbol-api), [files](/building-with-codegen/files-and-directories), [imports](/building-with-codegen/imports), and more. + +### Performance Through Pre-computation + +Pre-computing a rich index enables Codegen to make certain operations very fast that that are relevant to refactors and code analysis: + +- Finding all usages of a symbol +- Detecting circular dependencies +- Analyzing the dependency graphs +- Tracing call graphs +- Static analysis-based code retrieval for RAG +- ...etc. + + + Pre-parsing the codebase enables constant-time lookups rather than requiring + re-parsing or real-time analysis. + + +## Multi-Language Support + +One of Codegen's core principles is that many programming tasks are fundamentally similar across languages. + +Currently, Codegen supports: + +- [Python](/api-reference/python) +- [TypeScript](/api-reference/typescript) +- [React & JSX](/building-with-codegen/react-and-jsx) + + + Learn about how Codegen handles language specifics in the [Language + Support](/building-with-codegen/language-support) guide. + + +We've started with these ecosystems but designed our architecture to be extensible. The graph-based approach provides a consistent interface across languages while handling language-specific details under the hood. + +## Build with Us + +Codegen is just getting started, and we're excited about the possibilities ahead. We enthusiastically welcome contributions from the community, whether it's: + +- Adding support for new languages +- Implementing new analysis capabilities +- Improving performance +- Expanding the API +- Adding new transformations +- Improving documentation + +Check out our [community guide](/introduction/community) to get involved! diff --git a/docs/introduction/ide-usage.mdx b/docs/_deprecated/graph-sitter/ide-usage.mdx similarity index 100% rename from docs/introduction/ide-usage.mdx rename to docs/_deprecated/graph-sitter/ide-usage.mdx diff --git a/docs/introduction/installation.mdx b/docs/_deprecated/graph-sitter/installation.mdx similarity index 100% rename from docs/introduction/installation.mdx rename to docs/_deprecated/graph-sitter/installation.mdx diff --git a/docs/_deprecated/graph-sitter/overview.mdx b/docs/_deprecated/graph-sitter/overview.mdx new file mode 100644 index 000000000..4d428fc71 --- /dev/null +++ b/docs/_deprecated/graph-sitter/overview.mdx @@ -0,0 +1,159 @@ +--- +title: "Codegen" +sidebarTitle: "Overview" +icon: "code" +iconType: "solid" +--- + +[Codegen](https://github.com/codegen-sh/codegen-sdk) is a python library for manipulating codebases. + +It provides a scriptable interface to a powerful, multi-lingual language server built on top of [Tree-sitter](https://tree-sitter.github.io/tree-sitter/). + +```python +from codegen import Codebase + +# Codegen builds a complete graph connecting +# functions, classes, imports and their relationships +codebase = Codebase("./") + +# Work with code without dealing with syntax trees or parsing +for function in codebase.functions: + # Comprehensive static analysis for references, dependencies, etc. + if not function.usages: + # Auto-handles references and imports to maintain correctness + function.remove() + +# Fast, in-memory code index +codebase.commit() +``` + + + +Codegen handles complex refactors while maintaining correctness, enabling a broad set of advanced code manipulation programs. + + +Codegen works with both Python and Typescript/JSX codebases. Learn more about language support [here](/building-with-codegen/language-support). + +## Quick Started + + +Codegen requires Python 3.12 - 3.13 (recommended: Python 3.13+). + + +### Using UV (Recommended) +```bash +uv tool install codegen --python 3.13 +``` + +### Using Pipx + + +Pipx is not officially supported by Codegen, but it should still work. + + +```bash +pipx install codegen +``` + + +For further & more in depth installation instructions, see the [installation guide](/introduction/installation). + + +## What can I do with Codegen? + +Codegen's simple yet powerful APIs enable a range of applications, including: + + + + Create an intelligent agent that can analyze and manipulate your codebase using natural language. + + + Generate interactive visualizations of your codebase's structure, dependencies, and relationships. + + + Create high-quality training data for fine-tuning LLMs on your codebase. + + + Create powerful code transformations to automate large-scale changes. + + + +See below for an example call graph visualization generated with Codegen. + + + + + +View source code on [modal/modal-client](https://github.com/modal-labs/modal-client/blob/cbac0d80dfd98588027ecd21850152776be3ab82/modal/client.py#L70). View codemod on [codegen.sh](https://www.codegen.sh/codemod/66e2e195-ceec-4935-876a-ed4cfc1731c7/public/diff) + + +## Get Started + +import { + COMMUNITY_SLACK_URL, + CODEGEN_SDK_GITHUB_URL, +} from "/snippets/links.mdx"; + + + + Follow our step-by-step tutorial to start manipulating code with Codegen. + + + Learn how to use Codegen for common code transformation tasks. + + + Star us on GitHub and contribute to the project. + + + Get help and connect with the Codegen community. + + + +## Why Codegen? + +Many software engineering tasks - refactors, enforcing patterns, analyzing control flow, etc. - are fundamentally programmatic operations. Yet the tools we use to express these transformations often feel disconnected from how we think about code. + +Codegen was engineered backwards from real-world refactors we performed for enterprises at [Codegen, Inc.](/introduction/about). Instead of starting with theoretical abstractions, we built the set of APIs that map directly to how humans and AI think about code changes: + +- **Natural Mental Model**: Express transformations through high-level operations that match how you reason about code changes, not low-level text or AST manipulation. +- **Clean Business Logic**: Let the engine handle the complexities of imports, references, and cross-file dependencies. +- **Scale with Confidence**: Make sweeping changes across large codebases consistently across Python, TypeScript, JavaScript, and React. + +As AI becomes increasingly sophisticated, we're seeing a fascinating shift: AI agents aren't bottlenecked by their ability to understand code or generate solutions. Instead, they're limited by their ability to efficiently manipulate codebases. The challenge isn't the "brain" - it's the "hands." + +We built Codegen with a key insight: future AI agents will need to ["act via code,"](/blog/act-via-code) building their own sophisticated tools for code manipulation. Rather than generating diffs or making direct text changes, these agents will: + +1. Express transformations as composable programs +2. Build higher-level tools by combining primitive operations +3. Create and maintain their own abstractions for common patterns + +This creates a shared language that both humans and AI can reason about effectively, making code changes more predictable, reviewable, and maintainable. Whether you're a developer writing a complex refactoring script or an AI agent building transformation tools, Codegen provides the foundation for expressing code changes as they should be: through code itself. diff --git a/docs/introduction/work-with-ai.mdx b/docs/_deprecated/graph-sitter/work-with-ai.mdx similarity index 100% rename from docs/introduction/work-with-ai.mdx rename to docs/_deprecated/graph-sitter/work-with-ai.mdx diff --git a/docs/tutorials/at-a-glance.mdx b/docs/_deprecated/tutorials/at-a-glance.mdx similarity index 100% rename from docs/tutorials/at-a-glance.mdx rename to docs/_deprecated/tutorials/at-a-glance.mdx diff --git a/docs/tutorials/attributions.mdx b/docs/_deprecated/tutorials/attributions.mdx similarity index 100% rename from docs/tutorials/attributions.mdx rename to docs/_deprecated/tutorials/attributions.mdx diff --git a/docs/tutorials/build-mcp.mdx b/docs/_deprecated/tutorials/build-mcp.mdx similarity index 100% rename from docs/tutorials/build-mcp.mdx rename to docs/_deprecated/tutorials/build-mcp.mdx diff --git a/docs/tutorials/codebase-analytics-dashboard.mdx b/docs/_deprecated/tutorials/codebase-analytics-dashboard.mdx similarity index 100% rename from docs/tutorials/codebase-analytics-dashboard.mdx rename to docs/_deprecated/tutorials/codebase-analytics-dashboard.mdx diff --git a/docs/tutorials/codebase-visualization.mdx b/docs/_deprecated/tutorials/codebase-visualization.mdx similarity index 100% rename from docs/tutorials/codebase-visualization.mdx rename to docs/_deprecated/tutorials/codebase-visualization.mdx diff --git a/docs/tutorials/converting-default-exports.mdx b/docs/_deprecated/tutorials/converting-default-exports.mdx similarity index 100% rename from docs/tutorials/converting-default-exports.mdx rename to docs/_deprecated/tutorials/converting-default-exports.mdx diff --git a/docs/tutorials/creating-documentation.mdx b/docs/_deprecated/tutorials/creating-documentation.mdx similarity index 100% rename from docs/tutorials/creating-documentation.mdx rename to docs/_deprecated/tutorials/creating-documentation.mdx diff --git a/docs/tutorials/deep-code-research.mdx b/docs/_deprecated/tutorials/deep-code-research.mdx similarity index 100% rename from docs/tutorials/deep-code-research.mdx rename to docs/_deprecated/tutorials/deep-code-research.mdx diff --git a/docs/tutorials/deleting-dead-code.mdx b/docs/_deprecated/tutorials/deleting-dead-code.mdx similarity index 100% rename from docs/tutorials/deleting-dead-code.mdx rename to docs/_deprecated/tutorials/deleting-dead-code.mdx diff --git a/docs/tutorials/fixing-import-loops-in-pytorch.mdx b/docs/_deprecated/tutorials/fixing-import-loops-in-pytorch.mdx similarity index 100% rename from docs/tutorials/fixing-import-loops-in-pytorch.mdx rename to docs/_deprecated/tutorials/fixing-import-loops-in-pytorch.mdx diff --git a/docs/tutorials/flask-to-fastapi.mdx b/docs/_deprecated/tutorials/flask-to-fastapi.mdx similarity index 100% rename from docs/tutorials/flask-to-fastapi.mdx rename to docs/_deprecated/tutorials/flask-to-fastapi.mdx diff --git a/docs/tutorials/increase-type-coverage.mdx b/docs/_deprecated/tutorials/increase-type-coverage.mdx similarity index 100% rename from docs/tutorials/increase-type-coverage.mdx rename to docs/_deprecated/tutorials/increase-type-coverage.mdx diff --git a/docs/tutorials/manage-feature-flags.mdx b/docs/_deprecated/tutorials/manage-feature-flags.mdx similarity index 100% rename from docs/tutorials/manage-feature-flags.mdx rename to docs/_deprecated/tutorials/manage-feature-flags.mdx diff --git a/docs/tutorials/managing-typescript-exports.mdx b/docs/_deprecated/tutorials/managing-typescript-exports.mdx similarity index 100% rename from docs/tutorials/managing-typescript-exports.mdx rename to docs/_deprecated/tutorials/managing-typescript-exports.mdx diff --git a/docs/tutorials/migrating-apis.mdx b/docs/_deprecated/tutorials/migrating-apis.mdx similarity index 100% rename from docs/tutorials/migrating-apis.mdx rename to docs/_deprecated/tutorials/migrating-apis.mdx diff --git a/docs/tutorials/modularity.mdx b/docs/_deprecated/tutorials/modularity.mdx similarity index 100% rename from docs/tutorials/modularity.mdx rename to docs/_deprecated/tutorials/modularity.mdx diff --git a/docs/tutorials/neo4j-graph.mdx b/docs/_deprecated/tutorials/neo4j-graph.mdx similarity index 100% rename from docs/tutorials/neo4j-graph.mdx rename to docs/_deprecated/tutorials/neo4j-graph.mdx diff --git a/docs/tutorials/organize-your-codebase.mdx b/docs/_deprecated/tutorials/organize-your-codebase.mdx similarity index 100% rename from docs/tutorials/organize-your-codebase.mdx rename to docs/_deprecated/tutorials/organize-your-codebase.mdx diff --git a/docs/tutorials/preparing-your-codebase-for-ai.mdx b/docs/_deprecated/tutorials/preparing-your-codebase-for-ai.mdx similarity index 100% rename from docs/tutorials/preparing-your-codebase-for-ai.mdx rename to docs/_deprecated/tutorials/preparing-your-codebase-for-ai.mdx diff --git a/docs/tutorials/promise-to-async-await.mdx b/docs/_deprecated/tutorials/promise-to-async-await.mdx similarity index 100% rename from docs/tutorials/promise-to-async-await.mdx rename to docs/_deprecated/tutorials/promise-to-async-await.mdx diff --git a/docs/tutorials/python2-to-python3.mdx b/docs/_deprecated/tutorials/python2-to-python3.mdx similarity index 100% rename from docs/tutorials/python2-to-python3.mdx rename to docs/_deprecated/tutorials/python2-to-python3.mdx diff --git a/docs/tutorials/react-modernization.mdx b/docs/_deprecated/tutorials/react-modernization.mdx similarity index 100% rename from docs/tutorials/react-modernization.mdx rename to docs/_deprecated/tutorials/react-modernization.mdx diff --git a/docs/tutorials/slack-bot.mdx b/docs/_deprecated/tutorials/slack-bot.mdx similarity index 100% rename from docs/tutorials/slack-bot.mdx rename to docs/_deprecated/tutorials/slack-bot.mdx diff --git a/docs/tutorials/sqlalchemy-1.6-to-2.0.mdx b/docs/_deprecated/tutorials/sqlalchemy-1.6-to-2.0.mdx similarity index 100% rename from docs/tutorials/sqlalchemy-1.6-to-2.0.mdx rename to docs/_deprecated/tutorials/sqlalchemy-1.6-to-2.0.mdx diff --git a/docs/tutorials/training-data.mdx b/docs/_deprecated/tutorials/training-data.mdx similarity index 100% rename from docs/tutorials/training-data.mdx rename to docs/_deprecated/tutorials/training-data.mdx diff --git a/docs/tutorials/unittest-to-pytest.mdx b/docs/_deprecated/tutorials/unittest-to-pytest.mdx similarity index 100% rename from docs/tutorials/unittest-to-pytest.mdx rename to docs/_deprecated/tutorials/unittest-to-pytest.mdx diff --git a/docs/images/linear.png b/docs/images/linear.png new file mode 100644 index 000000000..d3d2398ed Binary files /dev/null and b/docs/images/linear.png differ diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx new file mode 100644 index 000000000..07fd98ace --- /dev/null +++ b/docs/integrations/github.mdx @@ -0,0 +1,43 @@ +--- +title: "GitHub Integration" +sidebarTitle: "GitHub" +icon: "github" +--- + +Connect Codegen to your GitHub repositories to enable agents to read code, create branches, commit changes, open pull requests, comment on issues, and more. + +## Capabilities + +Our GitHub integration grants Codegen agents both read and write access, allowing them to function like a member of your development team: + +- **Read Access:** Clone repositories, read file contents, inspect branches, view issues and PRs. +- **Write Access:** Create branches, push commits, open/update pull requests, comment on PRs and issues, assign reviewers. + +## How Agents Use GitHub + +Agents leverage the GitHub integration to: + +- **Understand Context:** Read code and related issues/PRs to grasp the task requirements. +- **Implement Changes:** Create branches and commit code directly based on your prompts. +- **Request Reviews:** Open pull requests and automatically request reviews from specified team members. +- **Report Progress:** Comment on related issues or PRs with updates, results, or requests for clarification. + +## Installation + +Authorize Codegen to access your GitHub organizations and repositories. + + + You can manage repository access granularly through the GitHub App settings. + + + + Click here to install the Codegen GitHub App and grant necessary permissions. + + + + Ensure the agent has access to the specific repositories it needs to work on. + diff --git a/docs/integrations/linear.mdx b/docs/integrations/linear.mdx new file mode 100644 index 000000000..687d74cb6 --- /dev/null +++ b/docs/integrations/linear.mdx @@ -0,0 +1,42 @@ +--- +title: "Linear Integration" +sidebarTitle: "Linear" +icon: "pencil" +--- + +Integrate Codegen with your Linear workspace to allow agents to interact with issues, manage projects, and keep your team updated. + + + +## Installation + +Connect your Linear workspace to Codegen to enable agent interactions. + + + Authorize Codegen to access your Linear workspace via the API settings. + + + + API access allows agents to interact with issues and projects according to + your permissions in Linear. + + +## Capabilities + +The Linear integration provides read and write access, enabling agents to manage tasks effectively: + +- **Read Access:** Fetch issue details, read comments, view project status, list team members. +- **Write Access:** Update issue status (e.g., to "In Progress", "Done"), add comments, link GitHub PRs to issues, create new issues, assign tasks. + +## How Agents Use Linear + +Agents use the Linear integration to streamline project management: + +- **Track Work:** Automatically update the status of issues they are working on. +- **Link Code:** Connect implemented changes (GitHub PRs) directly to the relevant Linear issue. +- **Provide Updates:** Post comments on issues with progress reports, results, or questions. +- **Create Tasks:** Generate new issues for follow-up work, bugs discovered, or sub-tasks. diff --git a/docs/integrations/sandboxes.mdx b/docs/integrations/sandboxes.mdx new file mode 100644 index 000000000..4ae38ea4a --- /dev/null +++ b/docs/integrations/sandboxes.mdx @@ -0,0 +1,34 @@ +--- +title: "Code Execution Sandboxes" +sidebarTitle: "Sandboxes" +icon: "box" +--- + +Codegen agents operate within secure, isolated sandbox environments where they can safely execute code, install dependencies, and run commands without affecting your local machine or production systems. + +## Capabilities + +Each sandbox provides a controlled environment with: + +- **File System Access:** Read, write, and modify files within the sandbox's temporary file system. +- **Terminal Access:** Execute shell commands (`bash`, `sh`, etc.) to run scripts, linters, formatters, build tools, and other necessary commands. +- **Process Execution:** Run code in various languages (Python, Node.js, etc., depending on the sandbox image). +- **Networking:** Controlled network access for tasks like installing packages or fetching data (can be restricted). + +## How Agents Use Sandboxes + +Agents utilize sandboxes for a variety of tasks: + +- **Testing Code:** Running unit tests, integration tests, or linters against the code they've written or modified. +- **Verifying Changes:** Executing the code to ensure it runs correctly before committing. +- **Installing Dependencies:** Using package managers (`pip`, `npm`, `yarn`) to install necessary libraries. +- **Running Tools:** Executing build scripts, code formatters, or other development utilities. + +## Configuration + +Sandboxes are typically configured per-agent run or defined within your Codegen settings. You often don't need to manage them directly, but advanced configurations might allow specifying Docker images or environment variables. + + + Sandboxes are ephemeral; their state is not typically persisted between agent + runs unless specifically configured for caching or stateful operations. + diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx new file mode 100644 index 000000000..0ab5253dc --- /dev/null +++ b/docs/integrations/slack.mdx @@ -0,0 +1,42 @@ +--- +title: "Slack Integration" +sidebarTitle: "Slack" +icon: "slack" +--- + +Connect Codegen to your Slack workspace to enable seamless communication between agents and your team. + +## Capabilities + +The Slack integration allows agents to interact within your designated channels: + +- **Send Messages:** Post updates, ask questions, report results, and notify team members. +- **Read Messages:** (Optional) Agents can be configured to read messages in specific channels to gather context or respond to requests (requires careful permission setup). +- **User Mentions:** Tag specific users or groups for notifications. + +## How Agents Use Slack + +Agents use Slack primarily for communication and notifications: + +- **Progress Updates:** Informing a channel or user when a task starts, encounters an issue, or is completed. +- **Requesting Feedback:** Asking for clarification or input on a specific implementation detail or ambiguity. +- **Sharing Results:** Posting links to created PRs, summaries of changes, or errors encountered. +- **Notifications:** Alerting the team about build failures, successful deployments, or critical issues identified. + +## Installation + +Add the Codegen Slack App to your workspace to enable agent communication. + + + Install the Codegen app from the Slack App Directory and choose the channels + it can access. + + + + Configure channel access carefully to ensure agents communicate in the + appropriate places. + diff --git a/docs/integrations/web-search.mdx b/docs/integrations/web-search.mdx new file mode 100644 index 000000000..66466dc5d --- /dev/null +++ b/docs/integrations/web-search.mdx @@ -0,0 +1,39 @@ +--- +title: "Web Search Integration" +sidebarTitle: "Web Search" +icon: "globe" +--- + +Connect Codegen to web search capabilities powered by exa to enable agents to search and retrieve information from the internet. + +## Capabilities + +Our web search integration, powered by exa, provides agents with the ability to search and understand web content: + +- **Real-time Search:** Access up-to-date information from across the internet. +- **Content Analysis:** Parse and extract relevant information from web pages. +- **Source Verification:** Evaluate and cite reliable sources for information. +- **Context Integration:** Incorporate web-sourced information into responses and solutions. + +## How Agents Use Web Search + +Agents utilize web search capabilities to: + +- **Research Solutions:** Find documentation, examples, and best practices for implementing features. +- **Stay Current:** Access the latest information about technologies, APIs, and development trends. +- **Verify Information:** Cross-reference facts and documentation from authoritative sources. +- **Gather Context:** Research domain-specific knowledge needed to better understand and solve problems. + +## Implementation + +Web search is automatically available to agents when needed, powered by exa's advanced search capabilities. + + + Discover how exa powers our web search capabilities with state-of-the-art + search technology. + + + + Agents automatically determine when to leverage web search to enhance their + responses and solutions with current, relevant information. + diff --git a/docs/introduction/about.mdx b/docs/introduction/about.mdx index d7ffe80a1..f6a065a30 100644 --- a/docs/introduction/about.mdx +++ b/docs/introduction/about.mdx @@ -13,18 +13,13 @@ iconType: "solid" ## Our Mission -Our mission is to build fully-autonomous software engineering - the equivalent of self-driving cars for code. +Our mission is to build fully-autonomous software engineering. -We believe the highest leverage path to autonomous development is enabling AI agents to "act via code." +We believe the most effective path towards this goal is through intelligent AI agents that seamlessly integrate into existing developer workflows. -Just as self-driving cars need sophisticated sensors and controls to navigate the physical world, AI agents need powerful, precise tools to manipulate codebases. We're building that foundational layer: a programmatic interface that lets AI agents express complex code transformations through code itself. +Our agents connect with tools developers use every day, like GitHub, Slack, and Linear, to automate tasks ranging from fixing bugs and implementing features to writing tests and improving documentation. -This approach creates a shared language that both humans and AI can use to: - -- Express powerful changes with precision and predictability -- Build sophisticated tools from primitive operations -- Create and maintain their own abstractions -- Scale transformations across massive codebases +By handling routine development tasks, Codegen empowers engineers to focus on higher-level challenges and accelerates the entire software development lifecycle. ## The Team diff --git a/docs/introduction/capabilities.mdx b/docs/introduction/capabilities.mdx new file mode 100644 index 000000000..d53b2a8de --- /dev/null +++ b/docs/introduction/capabilities.mdx @@ -0,0 +1,51 @@ +--- +title: "Agent Capabilities" +sidebarTitle: "Capabilities" +icon: "gear" +iconType: "solid" +--- + +Codegen agents come equipped with a versatile set of tools and capabilities designed to seamlessly integrate into your development workflow and automate a wide range of tasks. + +## Integrated Tool Suites + +Our agents have deep integrations with the tools your team already uses: + + + + Manage repositories, review PRs, comment on issues, create branches, commit + code, and more. + + + Update ticket statuses, add comments, link PRs, create new issues based on + findings, and manage project boards. + + + Send notifications, ask for clarification, report progress, and interact + directly with your team. + + + +## Core Features + +Beyond specific tool integrations, Codegen agents possess fundamental capabilities: + + + + Safely run code, install dependencies, and test changes in an isolated + environment. + + + Access up-to-date information, research libraries, find documentation, and + learn about new technologies. + + + + + These capabilities allow Codegen agents to handle complex tasks that require + interacting with multiple systems, just like a human developer. + diff --git a/docs/introduction/prompting.mdx b/docs/introduction/prompting.mdx new file mode 100644 index 000000000..06f3b608d --- /dev/null +++ b/docs/introduction/prompting.mdx @@ -0,0 +1,36 @@ +--- +title: "Effective Prompting" +sidebarTitle: "Prompting" +icon: "lightbulb" +iconType: "solid" +--- + +To get the best results from Codegen, treat it like a skilled teammate: provide clear, specific instructions and sufficient context. Vague requests lead to ambiguous outcomes. + + + Codegen is based on Anthropic's Claude 3.7. You can prompt it similarly to + ChatGPT or other LLM-based assistants + + +## The Core Principle: Specificity + +Instead of "Fix the user service," try: + +> In the `my-web-app` repo (PR #42), refactor the `UserService` class in `src/services/user.ts` to use the `UserRepository` pattern shown in `ProductService`/`ProductRepository`. + +If there are specific implementation details you want included, make sure to specify. For example: + +> Ensure all tests in `tests/services/user.test.ts` pass and add new tests for the repository with 90%+ coverage. Update the diagram in `docs/architecture/user-service.md`. + +## Elements of a Strong Prompt + +1. **Scope:** What repository, branch, or files are involved? (e.g., `my-web-app` repo, `PR #42`, `src/services/user.ts`) +2. **Goal:** What is the high-level objective? (e.g., Refactor `UserService`, improve testability) +3. **Tasks:** What specific actions should the agent take? Use a numbered or bulleted list for clarity. (e.g., Extract logic to `UserRepository`, use dependency injection, update tests, update diagram) +4. **Context/Patterns:** Are there existing patterns, examples, or documentation to reference? (e.g., `ProductService`, `ProductRepository`) +5. **Success Criteria:** How will you know the task is done correctly? (e.g., Tests pass, 90%+ coverage, diagram updated) + + + Clear, detailed prompts empower Codegen agents to deliver accurate results + faster, significantly streamlining your workflow. + diff --git a/docs/mint.json b/docs/mint.json index 091a684a7..a78c2d711 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -68,11 +68,23 @@ "group": "Introduction", "pages": [ "introduction/overview", + "introduction/capabilities", + "introduction/prompting", "introduction/community", "introduction/about", "introduction/faq" ] }, + { + "group": "Integrations", + "pages": [ + "integrations/slack", + "integrations/linear", + "integrations/github", + "integrations/web-search", + "integrations/sandboxes" + ] + }, { "group": "Changelog", "pages": ["changelog/changelog"]