Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation site #1882

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

Update documentation site #1882

wants to merge 25 commits into from

Conversation

KuechA
Copy link
Contributor

@KuechA KuechA commented Dec 4, 2024

Some information on the documentation site is outdated. This PR fixes this problem

@KuechA
Copy link
Contributor Author

KuechA commented Dec 4, 2024 •
edited
Loading

  • @oxisto should update the inference configuration documentation since this was changed recently. Do we have more things in mind which require an update?

@KuechA
Copy link
Contributor Author

KuechA commented Jan 9, 2025 •
edited
Loading

  • We should also add a documentation of the overlay and concept/operations and the intended usage. -> initial version in specs/overlays.md. @konradweiss please check
  • Update the Getting Started pages to remove the "installing" part and integrate it in the CLI, console and neo4j usage sections.

@KuechA KuechA marked this pull request as ready for review January 10, 2025 14:22
@KuechA KuechA requested a review from konradweiss as a code owner January 10, 2025 14:22
@KuechA KuechA requested a review from oxisto as a code owner January 10, 2025 14:22
oxisto
oxisto reviewed Jan 11, 2025
View reviewed changes
Copy link
Member

@oxisto oxisto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the inference stuff, the rest looks good.

docs/docs/CPG/specs/overlays.md

Our basic version of the CPG only considers nodes that are part
of the CPG's immediate representation of the program's AST (we denote
these nodes as $N_{AST} \subseteq N_{CPG}$).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the latex syntax to work we would need to fetch an additional javascript pkg from unpkg.com or similar. Do we want/need that? See https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax

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

@oxisto oxisto oxisto left review comments

@konradweiss konradweiss Awaiting requested review from konradweiss konradweiss is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KuechA @oxisto