Skip to content

Add CLAUDE.md documenting codebase structure and workflows#45205

Open
xmesutx wants to merge 1 commit into
github:mainfrom
xmesutx:claude/claude-md-docs-sciyca
Open

Add CLAUDE.md documenting codebase structure and workflows#45205
xmesutx wants to merge 1 commit into
github:mainfrom
xmesutx:claude/claude-md-docs-sciyca

Conversation

@xmesutx

@xmesutx xmesutx commented Jul 18, 2026

Copy link
Copy Markdown

Covers dev/test/lint commands, the content/data/translations model, request-rendering pipeline, and generated REST/GraphQL/webhook docs for future Claude Code sessions working in this repo.

Claude-Session: https://claude.ai/code/session_01DDqxsqz2YkydC6mnfJ5T2o

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Covers dev/test/lint commands, the content/data/translations model,
request-rendering pipeline, and generated REST/GraphQL/webhook docs
for future Claude Code sessions working in this repo.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DDqxsqz2YkydC6mnfJ5T2o
@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jul 18, 2026
@ChihweiLHBird

ChihweiLHBird commented Jul 20, 2026

Copy link
Copy Markdown

Vendor agnostic AGENTS.md is the better option here. Claude is a registered trade mark of Anthropic and may cause legal issues.

@heardjalissa9-gif heardjalissa9-gif left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

CREATE USER 'resourcespace_r'@'localhost' IDENTIFIED BY 'your_r_password';
GRANT SELECT ON resourcespace.* To 'resourcespace_r'@'localhost';

#45217

Comment thread CLAUDE.md
@@ -0,0 +1,93 @@
# CLAUDE.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I'm taking applicants to help me work on it are you there
"priority": {
"textEditor": "default",
"diffEditor": "option",
"mergeEditor": "never"
#45217

Navigating code on GitHub

You can understand the relationships within and across repositories by navigating code directly in GitHub.

About navigating code on GitHub

Code navigation helps you to read, navigate, and understand code by showing and linking definitions of a named entity corresponding to a reference to that entity, as well as references corresponding to an entity's definition.

Screenshot showing a file with a function highlighted. A pop-up has information about the function on two tabs: "Definition" and "Reference".

Code navigation uses the open source tree-sitter library. The following languages support code navigation.

  • Bash
  • C
  • C#
  • C++
  • CodeQL
  • Elixir
  • Go
  • JSX
  • Java
  • JavaScript
  • Lua
  • PHP
  • Protocol Buffers
  • Python
  • R
  • Ruby
  • Rust
  • Scala
  • Starlark
  • Swift
  • Typescript

You do not need to configure anything in your repository to enable code navigation. We will automatically extract code navigation information for these supported languages in all repositories.

GitHub has developed a code navigation approach based on the open source tree-sitter library that searches all definitions and references across a repository to find entities with a given name.

You can use keyboard shortcuts to navigate within a code file. For more information, see Keyboard shortcuts.

Using the symbols pane

You can now quickly view and navigate between symbols such as functions or classes in your code with the symbols pane. You can search for a symbol in a single file, in all files in a repository, or even in all public repositories on GitHub.

Symbol search is a feature of code search. For more information, see Understanding GitHub Code Search syntax.

  1. Select a repository, then navigate to a file containing symbols.

  2. To bring up the symbols pane, above the file content, click .

    Alternatively, you can open the symbols pane by clicking an eligible symbol in your file. Clickable symbols are highlighted in yellow when you hover over them.

  3. Click the symbol you would like to find from the symbols pane or within the file itself.

    • To search for a symbol in the repository as a whole, in the symbols pane, click Search for this symbol in this repository. To search for a symbol in all repositories on GitHub, click all repositories.
  4. To navigate between references to a symbol, click or .

  5. To navigate to a specific reference to a symbol, click a result of the symbol search under In this file.

  6. To exit the search for a specific symbol, click All Symbols.

Jumping to the definition of a function or method

You can jump to a function or method's definition within the same repository by clicking the function or method call in a file.

Screenshot of the function window. A section, titled "Definition," is outlined in dark orange.

Finding all references of a function or method

You can find all references for a function or method within the same repository by clicking the function or method call in a file.

Screenshot of the function window. A section, titled "3 References," is outlined in dark orange.

Troubleshooting code navigation

If code navigation is enabled for you but you don't see links to the definitions of functions and methods:

  • Code navigation only works for active branches. Push to the branch and try again.
  • Code navigation only works for repositories with fewer than 100,000 files.

Further reading

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

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants