Skip to content

Fix editLink для продуктов не учитывает orgName из repositories.json #75

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.

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

Merged
merged 13 commits into from
Jun 11, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 11, 2025

The editLink pattern for products was not correctly using the organization name from repositories.json for external repositories.

Problem:
For the repository nixel2007/extends, the generated edit link was incorrectly pointing to autumn-library/extends instead of the correct nixel2007/extends. This occurred because the editLink pattern function was trying to extract repository information from the rewritten path (after URL rewrites), but the rewritten path no longer contained the repository name in the expected format.

Root Cause:

  1. transformPageData correctly extracted organization from the original path (products/003-extends/010-index.md)
  2. rewrites() function transformed the path to extends/index.md
  3. editLink.pattern tried to parse the rewritten path and incorrectly extracted repoName as "index.md" instead of "extends"

Solution:

  • Enhanced transformPageData to store both organization and repository in page params
  • Updated editLink.pattern to use the stored repository information instead of parsing the rewritten path
  • Added fallback logic to maintain backward compatibility

Before:

// editLink pattern tried to extract repo from rewritten path
const [_, repoName, ...rest] = relativePath.split('/') // relativePath = "extends/index.md"
const repoNamePath = repoName?.replace(/\d+-/g, '') || '' // repoNamePath = "index.md" ❌

After:

// editLink pattern uses stored repository information
const organization = pageData.params?.organization; // "nixel2007" ✅
const repository = pageData.params?.repository;     // "extends" ✅

Testing:

  • nixel2007/extends now generates correct URL: https://github.com/nixel2007/extends/edit/master/docs/product/index.md
  • ✅ All autumn-library repositories continue to work correctly
  • ✅ API links work correctly for all repositories
  • ✅ Build completes successfully

Fixes #73.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] editLink для продуктов не учитывает orgName из repositories.json Fix editLink для продуктов не учитывает orgName из repositories.json Jun 11, 2025
@Copilot Copilot AI requested a review from nixel2007 June 11, 2025 15:27
Copilot finished work on behalf of nixel2007 June 11, 2025 15:27
…[0] instead of split[1]

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 15:47
…ework-elements)

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 16:01
Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 16:12
Copy link

coderabbitai bot commented Jun 11, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.


// Common calculation for repo extraction from relativePath
// Fallback to old logic for paths that don't have repo info
Copy link
Member

Choose a reason for hiding this comment

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

Delete fallback logic, just return ''

Copy link
Member

Choose a reason for hiding this comment

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

Ещё разок

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed fallback logic as requested - now just returns empty string when organization and repository data is not available. This ensures only reliable edit links are shown. Fixed in 8f6637e.

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 16:25

if (pageData.relativePath.startsWith('api/')) {
// For API paths, repository name is in the second segment after rewrite
repoName = pageData.relativePath.split('/')[1]?.replace(/\d+-/g, '') || '';
Copy link
Member

Choose a reason for hiding this comment

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

Разве для relativePath нужно применять корректирующий replace? Проверь в логах.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're absolutely correct! The replace operation was unnecessary. After URL rewrites, the relativePath already has numbers stripped out:

  • api/000-autumn/...api/autumn/... (no numbers in "autumn")
  • products/003-extends/...extends/... (no numbers in "extends")

The replace(/\d+-/g, '') operations were redundant. Fixed in 780c011.

return `https://github.com/${orgName}/${repoNamePath}/edit/master/docs/product/${restPath}`
// For product pages - use filePath to determine if it's autumn docs
if (pageData.filePath && pageData.filePath.includes('products/000-autumn')) {
// This is autumn documentation at root level - path after first segment
Copy link
Member

Choose a reason for hiding this comment

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

Кажется, ты здесь ошибся. Для autumn rest будет начиная с первого сегмента. Перепроверь эту функцию целиком.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're absolutely correct! For autumn docs, rest should include all segments from the relativePath. After URL rewrite, autumn paths like getting-started/about-autumn.md should use the entire path, not skip the first segment. Fixed the logic to use const restPath = relativePath for autumn docs while keeping the segment skipping for other repositories. Edit links now work correctly - fixed in 81275ef.

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 16:34
…first segment

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 16:44
} else {
// Use filePath to determine if this is autumn documentation
// pageData.filePath contains the original path before rewrites
if (pageData.filePath && pageData.filePath.includes('products/000-autumn')) {
Copy link
Member

Choose a reason for hiding this comment

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

Можно для всех вариантов использовать filePath, разве нет?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're absolutely right! I've simplified the logic to use filePath consistently for all variants instead of the mixed approach. Now both API and product paths extract repository names from filePath by parsing the directory structure (api/000-autumn → autumn, products/003-extends → extends) rather than mixing relativePath and filePath approaches. This is much cleaner and more consistent. Fixed in c824520.

…ed approach

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 17:00
@nixel2007 nixel2007 marked this pull request as ready for review June 11, 2025 17:03
@nixel2007 nixel2007 merged commit 28534d6 into master Jun 11, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

editLink для продуктов не учитывает orgName из repositories.json
2 participants