upgraded styling on docs

jemeza-codegen · jemeza-codegen · commit 3db9b80f1d6b · 2025-01-23T19:03:26.000-08:00
diff --git a/codegen-git/src/codegen_git/utils/clone_url.py b/codegen-git/src/codegen_git/utils/clone_url.py
@@ -7,7 +7,7 @@
 
 def url_to_github(url: str, branch: str) -> str:
     clone_url = url.removesuffix(".git").replace("git@github.com:", "github.com/")
-    return f"https://{clone_url}/blob/{branch}"
+    return f"{clone_url}/blob/{branch}"
 
 
 def get_clone_url_for_repo_config(repo_config: RepoConfig, github_type: GithubType = GithubType.GithubEnterprise) -> str:
diff --git a/docs/mint.json b/docs/mint.json
@@ -12,7 +12,7 @@
 	"colors": {
 		"primary": "#a277ff",
 		"light": "#a277ff",
-		"dark": "#a277ff",
+		"dark": "#575453",
 		"anchors": {
 			"from": "#61ffca",
 			"to": "#61ffca"
diff --git a/docs/snippets/Attribute.mdx b/docs/snippets/Attribute.mdx
@@ -0,0 +1,8 @@
+export const Attribute = ({ type, description }) => (
+  <div className="py-6 first:pt-3 dark:border-gray-300/[0.06] text-sm font-normal">
+    <div className="inline-grid grid-cols-[auto_auto] gap-1 font-mono py-2">
+      {type}
+    </div>
+    <p className="mt-2">{description}</p>
+  </div>
+)
diff --git a/docs/snippets/GithubLinkNote.mdx b/docs/snippets/GithubLinkNote.mdx
@@ -0,0 +1,5 @@
+export const GithubLinkNote = ({link}) => (
+   <Info>
+      <div className="flex gap-5 items-center">View Source on <a target="_blank"  rel="noopener noreferrer" href={link}> Github</a></div>
+   </Info>
+)
diff --git a/docs/snippets/HorizontalDivider.mdx b/docs/snippets/HorizontalDivider.mdx
@@ -0,0 +1,6 @@
+export const HorizontalDivider = ({light=false}) => (
+    <div className="divide-y">
+        <div className={`divide-y ${light ? "dark:border-gray-300/[0.06]" : "border-gray-600"}`}></div>
+        <div className={`divide-y ${light ? "dark:border-gray-300/[0.06]" : "border-gray-600"}`}></div>
+    </div>
+)
diff --git a/docs/snippets/Parameter.mdx b/docs/snippets/Parameter.mdx
@@ -1,17 +1,28 @@
-export const Parameter = ({name, type, required, description, defaultValue}) => (
-  <div className="py-6 first:pt-3 border-gray-600 text-sm font-normal">
-    <div className="flex gap-4 items-center">
-      <code className="text-sm bg-gray-100 px-2 py-0.5 rounded">{name}</code>
+export const Parameter = ({name, type, description, defaultValue}) => (
+  <div className="py-6 first:pt-3 dark:border-gray-300/[0.06] text-sm font-normal">
+    <div className="flex justify-between items-start font-mono">
+      <div className="flex gap-4 items-start">
+        <div className="flex gap-1 items-center text-sm text-primary mt-2">
+          {name}
+        </div>
+        <div className="inline-grid grid-cols-[auto_auto] gap-1 py-2">
+          {type}
+        </div>
+      </div>
 
-        {type}
-
-
-      {required && <span className="text-sm border border-purple-500 px-2 py-0.5 rounded">required</span>}
-      { defaultValue && <div className="flex gap-4 items-center text-sm border border-purple-500 px-2 py-0.5 rounded">
-        <span className="text-gray-500">Default:</span>
-        <span className="text-purple-500">{defaultValue}</span>
-      </div>}
+      <div className="flex-shrink-0 mt-2">
+        {defaultValue ? (
+          <div className="flex gap-1 items-center text-sm border border-purple-500 px-2 py-0.5 rounded">
+            <span className="text-gray-500">default:</span>
+            <span className="text-purple-500">{defaultValue}</span>
+          </div>
+        ) : (
+          <span className="text-sm border border-purple-500 px-2 py-0.5 rounded">
+            required
+          </span>
+        )}
+      </div>
     </div>
-    <p className="mt-2 text-white">{description}</p>
+    <p className="mt-2">{description}</p>
   </div>
 )
diff --git a/docs/snippets/ParameterWrapper.mdx b/docs/snippets/ParameterWrapper.mdx
@@ -1,7 +1,7 @@
 export const ParameterWrapper = ({ children }) => (
   <div className="pl-6 divide-y">
     <h4 className="font-bold">Parameters</h4>
-    <div className="divide-y border-gray-600">
+    <div className="divide-y dark:border-gray-300/[0.06]">
       {children}
     </div>
   </div>
diff --git a/docs/snippets/Return.mdx b/docs/snippets/Return.mdx
@@ -1,14 +1,14 @@
 export const Return = ({return_type, description}) => (
   <div className="pl-6 divide-y">
     <h4 className="font-bold">Returns</h4>
-    <div className="border-gray-600 ">
+    <div className="dark:border-gray-300/[0.06] ">
         <div className="py-6 first:pt-3 text-sm font-normal">
             <div className="flex gap-4 items-center">
-                <div className="relative">
+                <div className="inline-grid grid-cols-[auto_auto] gap-1 font-mono py-2">
                     {return_type}
                 </div>
             </div>
-            <p className="mt-2 text-white">{description}</p>
+            <p className="mt-2">{description}</p>
         </div>
     </div>
   </div>
diff --git a/src/graph_sitter/code_generation/doc_utils/generate_docs_json.py b/src/graph_sitter/code_generation/doc_utils/generate_docs_json.py
@@ -9,7 +9,7 @@
 from graph_sitter.core.class_definition import Class
 from graph_sitter.core.codebase import Codebase
 
-ATTRIBUTES_TO_IGNORE = ["G", "node_id"]
+ATTRIBUTES_TO_IGNORE = ["G", "node_id", "angular"]
 
 
 def generate_docs_json(codebase: Codebase, head_commit: str) -> dict[str, dict[str, Any]]:
@@ -25,12 +25,21 @@ def generate_docs_json(codebase: Codebase, head_commit: str) -> dict[str, dict[s
     types_cache = {}
     attr_cache = {}
 
-    def update_class_doc(cls):
+    def process_class_doc(cls):
         """Update or create documentation for a class."""
         description = cls.docstring.source.strip('"""') if cls.docstring else None
         parent_classes = [f"<{create_path(parent)}>" for parent in cls.superclasses if isinstance(parent, Class) and has_documentation(parent)]
 
-        cls_doc = ClassDoc(title=cls.name, description=description, content=" ", path=create_path(cls), inherits_from=parent_classes, language=get_langauge(cls), version=str(head_commit))
+        cls_doc = ClassDoc(
+            title=cls.name,
+            description=description,
+            content=" ",
+            path=create_path(cls),
+            inherits_from=parent_classes,
+            language=get_langauge(cls),
+            version=str(head_commit),
+            github_url=cls.github_url,
+        )
 
         return cls_doc
 
@@ -47,7 +56,6 @@ def process_method(method, cls, cls_doc, seen_methods):
             return
 
         method_path = create_path(method, cls)
-        original_method_path = create_path(method)
         parameters = []
 
         parsed = parse_docstring(method.docstring.source)
@@ -88,6 +96,7 @@ def process_method(method, cls, cls_doc, seen_methods):
             raises=parsed["raises"],
             metainfo=meta_data,
             version=str(head_commit),
+            github_url=method.github_url,
         )
 
     def process_attribute(attr, cls, cls_doc, seen_methods):
@@ -122,14 +131,15 @@ def process_attribute(attr, cls, cls_doc, seen_methods):
             raises=[],
             metainfo=meta_data,
             version=str(head_commit),
+            github_url=attr.github_url,
         )
 
     # Process all documented classes
     documented_classes = [cls for cls in codebase.classes if has_documentation(cls)]
 
     for cls in tqdm(documented_classes):
         try:
-            cls_doc = update_class_doc(cls)
+            cls_doc = process_class_doc(cls)
             graph_sitter_docs.classes.append(cls_doc)
             seen_methods = set()
 
diff --git a/src/graph_sitter/code_generation/doc_utils/schemas.py b/src/graph_sitter/code_generation/doc_utils/schemas.py
@@ -22,6 +22,7 @@ class MethodDoc(BaseModel):
     raises: list[dict] | None = Field(..., description="The raises of the method")
     metainfo: dict = Field(..., description="Information about the method's true parent class and path")
     version: str = Field(..., description="The commit hash of the git commit that generated the docs")
+    github_url: str = Field(..., description="The github url of the method")
 
 
 class ClassDoc(BaseModel):
@@ -34,6 +35,7 @@ class ClassDoc(BaseModel):
     version: str = Field(..., description="The commit hash of the git commit that generated the docs")
     methods: list[MethodDoc] = Field(default=[], description="The methods of the class")
     attributes: list[MethodDoc] = Field(default=[], description="The attributes of the class")
+    github_url: str = Field(..., description="The github url of the class")
 
 
 class GSDocs(BaseModel):
diff --git a/src/graph_sitter/code_generation/mdx_docs_generation.py b/src/graph_sitter/code_generation/mdx_docs_generation.py
@@ -26,6 +26,11 @@ def render_mdx_page_title(cls_doc: ClassDoc, icon: str | None = None) -> str:
 import {{Parameter}} from '/snippets/Parameter.mdx';
 import {{ParameterWrapper}} from '/snippets/ParameterWrapper.mdx';
 import {{Return}} from '/snippets/Return.mdx';
+import {{HorizontalDivider}} from '/snippets/HorizontalDivider.mdx';
+import {{GithubLinkNote}} from '/snippets/GithubLinkNote.mdx';
+import {{Attribute}} from '/snippets/Attribute.mdx';
+
+<GithubLinkNote link="{cls_doc.github_url}" />
 """
 
 
@@ -49,7 +54,7 @@ def render_mdx_attributes_section(cls_doc: ClassDoc) -> str:
     attributes_mdx_string = "\n".join([render_mdx_for_attribute(attribute) for attribute in sorted_attributes])
 
     return f"""## Attributes
----
+<HorizontalDivider />
 {attributes_mdx_string}
 """
 
@@ -62,13 +67,7 @@ def render_mdx_methods_section(cls_doc: ClassDoc) -> str:
     methods_mdx_string = "\n".join([render_mdx_for_method(method) for method in sorted_methods if method.method_type == "method"])
 
     return f"""## Methods
-<div className="divide-y">
-    <div className="divide-y">
-    </div>
-    <div className="divide-y">
-    </div>
-</div>
-
+<HorizontalDivider />
 {methods_mdx_string}
 """
 
@@ -77,13 +76,14 @@ def render_mdx_for_attribute(attribute: MethodDoc) -> str:
     """Renders the MDX for a single attribute"""
     attribute_docstring = sanitize_mdx_mintlify_description(attribute.description)
     if len(attribute.return_type) > 0:
-        return_type = f": {parse_link(attribute.return_type[0])}"
+        return_type = f"{resolve_type_string(attribute.return_type[0])}"
     else:
         return_type = ""
     if not attribute_docstring:
         attribute_docstring = "\n"
-    return f"""### `{attribute.name}` {return_type}
-{attribute_docstring}
+    return f"""### <span className="text-primary">{attribute.name}</span>
+<HorizontalDivider light={{true}} />
+<Attribute type={{ {return_type if return_type else "<span></span>"} }} description="{attribute_docstring}" />
 """
 
 
@@ -98,7 +98,6 @@ def format_parameter_for_mdx(parameter: ParameterDoc) -> str:
 <Parameter
     name="{parameter.name}"
     type={{ {type_string} }}
-    required="{"true" if isinstance(parameter.default, str) and not parameter.default else ""}"
     description="{sanitize_html_for_mdx(parameter.description)}"
     defaultValue="{sanitize_html_for_mdx(parameter.default)}"
 />
@@ -123,8 +122,9 @@ def render_mdx_for_method(method: MethodDoc) -> str:
     # =====[ RENDER ]=====
     # TODO add links here
     # TODO add inheritence info here
-    mdx_string = f"""### `{method.name}`
+    mdx_string = f"""### <span className="text-primary">{method.name}</span>
 {description}
+<GithubLinkNote link="{method.github_url}" />
 """
     if method.parameters:
         mdx_string += f"""
@@ -153,11 +153,16 @@ def get_mdx_route_for_class(cls_doc: ClassDoc) -> str:
         return f"codebase-sdk/core/{cls_doc.title}"
 
 
+def format_type_string(type_string: str) -> str:
+    type_string = type_string.split("|")
+    return " | ".join([type_str.strip() for type_str in type_string])
+
+
 def resolve_type_string(type_string: str) -> str:
     if "<" in type_string:
         return f"<>{parse_link(type_string, href=True)}</>"
     else:
-        return f'<code className="text-sm bg-gray-100 px-2 py-0.5 rounded">{type_string}</code>'
+        return f'<code className="text-sm bg-gray-100 px-2 py-0.5 rounded">{format_type_string(type_string)}</code>'
 
 
 def format_builtin_type_string(type_string: str) -> str:
@@ -167,6 +172,13 @@ def format_builtin_type_string(type_string: str) -> str:
     return type_string
 
 
+def span_type_string_by_pipe(type_string: str) -> str:
+    if "|" in type_string:
+        type_strings = type_string.split("|")
+        return " | ".join([f"<span>{type_str.strip()}</span>" for type_str in type_strings])
+    return type_string
+
+
 def parse_link(type_string: str, href: bool = False) -> str:
     # Match components with angle brackets, handling nested structures
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +export const GithubLinkNote = ({link}) => (
 +   <Info>
 +      <div className="flex gap-5 items-center">View Source on <a target="_blank"  rel="noopener noreferrer" href={link}> Github</a></div>
 +   </Info>
 +)