Skip to content

Minor Improvements#72

Open
Lightning11wins wants to merge 3 commits intoLightSys:masterfrom
Lightning11wins:master
Open

Minor Improvements#72
Lightning11wins wants to merge 3 commits intoLightSys:masterfrom
Lightning11wins:master

Conversation

@Lightning11wins
Copy link
Copy Markdown
Contributor

While reading some docs, I made a few minor improvements. These only improve the docs by about 5-10%, so they might not even be worth the time to review. Still, I'll leave this here in case we decide to use it at some point.

@Lightning11wins Lightning11wins changed the title Minor Clarity Improvements to Docs Minor Improvements Jun 20, 2025
@Lightning11wins
Copy link
Copy Markdown
Contributor Author

I wanted to make sure that devs using IntelliJ IDEA didn't accidentally push their editor files. I doubt most of us are using that editor, but it was an easy change to make.

@Lightning11wins Lightning11wins self-assigned this Nov 26, 2025
@Lightning11wins Lightning11wins marked this pull request as draft December 15, 2025 19:42
@Lightning11wins
Copy link
Copy Markdown
Contributor Author

Lightning11wins commented Jan 8, 2026

This looks like fine, usable work. It's not at all a large PR, but it's still a small improvement on the pieces of documentation that it improves.

@Lightning11wins Lightning11wins marked this pull request as ready for review January 8, 2026 17:58
@Lightning11wins
Copy link
Copy Markdown
Contributor Author

Also, looks like I forgot to label this, so that's fixed now.

@Lightning11wins Lightning11wins added the ai-review Request AI review of this PR label Mar 3, 2026
@Lightning11wins
Copy link
Copy Markdown
Contributor Author

@greptileai Please review this PR.

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 3, 2026

Greptile Summary

This PR makes minor documentation improvements to centrallix-sysdoc/javascript.md and centrallix-sysdoc/serverside_html_generation.md (formatting, prose clarity, syntax highlighting on code blocks, a new Table of Contents) and adds a *.idea/* entry to .gitignore. The changes are low-risk but contain a few small correctness issues that should be addressed before merging.

Key findings:

  • Both markdown files still reference companion files with the old .txt extension (serverside_html_generation.txt and javascript.txt) rather than their current .md filenames, leaving broken cross-references for readers.
  • serverside_html_generation.md line 16 contains tautological phrasing: "the generated javascript that is generated."
  • The new Table of Contents in serverside_html_generation.md uses a mixed-case anchor (#Serverside-HTML-Generation) for the top-level heading, which will not resolve correctly in GitHub's Markdown renderer.
  • The new *.idea/* entry in .gitignore is redundant and less comprehensive than the already-present .idea/ entry — it only matches direct children of *.idea/ directories, missing deeper nested files that .idea/ covers recursively.

Confidence Score: 3/5

  • Safe to merge after fixing the stale .txt cross-references and the broken ToC anchor — no code logic is affected.
  • All changes are documentation and .gitignore only — no executable code is touched. However, there are a couple of objective correctness issues (broken cross-references and a broken anchor) that reduce confidence below a clean pass.
  • centrallix-sysdoc/serverside_html_generation.md needs the most attention: it has a broken ToC anchor, a stale .txt cross-reference, and redundant phrasing. centrallix-sysdoc/javascript.md also needs its .txt cross-reference corrected.

Important Files Changed

Filename Overview
.gitignore Adds *.idea/* at the top of the file, but this pattern is redundant and less comprehensive than the existing .idea/ entry on line 63.
centrallix-sysdoc/javascript.md Documentation improvements: bolded Author/Date, added js syntax highlighting to code blocks, improved prose clarity, and updated a Prototype.js URL — but the cross-reference on line 15 still points to serverside_html_generation.txt instead of .md.
centrallix-sysdoc/serverside_html_generation.md Documentation improvements including a new Table of Contents and formatting fixes, but contains a stale .txt cross-reference, redundant phrasing ("the generated javascript that is generated"), and a broken anchor link in the ToC for the top-level heading.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Client requests a .app URI] --> B[Server identifies URI as an App]
    B --> C["1) wgtrParseOpenObject\nTraverses app file via OSML\nProduces WgtrNode struct"]
    C --> D["2) Apos Unit\nAuto Positioning of WgtrNode"]
    D --> E["3) htrRender\nTraverses WgtrNode tree"]
    E --> F{For each widget}
    F --> G["Run *Render function\n(htmlgen/htdrv_*.c)"]
    G --> H["htrAddScriptInclude\n<script> includes"]
    G --> I["htrAddStylesheetItem\nCSS information"]
    G --> J["htrAddBodyItem\nActual HTML"]
    G --> K["htrAddScriptInit\nstartup_* onload handler"]
    G --> L["htrBuildClientWgtr\nJSON-like widget tree\n+ wgtrSetupTree invocation"]
    H & I & J & K & L --> M[HtPage instance assembled]
    M --> N[Full HTML page returned to client]
    N --> O["Client extracts desired parts\nfrom iframe / layer\nand inserts into main page"]
Loading

Last reviewed commit: 2de5c14

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@Lightning11wins
Copy link
Copy Markdown
Contributor Author

PR cleared for human review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review Request AI review of this PR enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant