Skip to content

docs: add Spanish README - #150

Open
webbrain-one wants to merge 1 commit into
adikari:masterfrom
webbrain-one:webbrain/readme-translation
Open

docs: add Spanish README#150
webbrain-one wants to merge 1 commit into
adikari:masterfrom
webbrain-one:webbrain/readme-translation

Conversation

@webbrain-one

@webbrain-one webbrain-one commented Aug 2, 2026

Copy link
Copy Markdown

Adds README.es-ES.md alongside the original documentation.

Summary by CodeRabbit

  • Documentation
    • Added Spanish-language documentation for the package.
    • Included installation instructions, Apollo setup, server-side rendering guidance, authentication details, licensing, and status badges.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The pull request adds README.es-ES.md, a Spanish README for nextjs-with-apollo. It covers installation, Apollo setup, SSR options, authenticated SSR, licensing, badges, and reference links.

Changes

Spanish README

Layer / File(s) Summary
Project setup and metadata
README.es-ES.md
The README adds Spanish project metadata, npm and Yarn installation commands, badges, MIT license text, and badge reference URLs.
Apollo integration and SSR usage
README.es-ES.md
The README documents Apollo client creation, cache hydration, HOC integration, query rendering, optional SSR disabling, and apolloClient access through getInitialProps.
Authenticated SSR example
README.es-ES.md
The README documents cookie token extraction, Bearer authorization headers, HTTP link configuration, and Apollo cache restoration.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit reads the Spanish guide,
Apollo hops from side to side.
Cookies guard the SSR door,
Cache returns with data galore.
Badges shine, and docs take flight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the addition of a Spanish README, which matches the pull request changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.es-ES.md`:
- Around line 145-151: Update the createApolloClient example to resolve the
undefined GRAPHQL_ENDPOINT reference by reusing the existing GRAPHQL_URL
constant or declaring GRAPHQL_ENDPOINT before the HttpLink configuration.
- Around line 56-72: Update the ProfilePage example so its identifiers are
defined and consistent: import the project’s gql helper alongside the existing
imports, and pass the declared QUERY constant to useQuery instead of the
undefined PROFILE_QUERY.
- Around line 98-100: Update the Markdown code fence surrounding the
withApollo(ProfilePage, { ssr: false }) example in README.es-ES.md to specify
the JavaScript language using a js fence, while preserving the example content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a657ec48-d427-48fd-860b-a20409f3fb91

📥 Commits

Reviewing files that changed from the base of the PR and between 43f4022 and 56bf2b7.

📒 Files selected for processing (1)
  • README.es-ES.md

Comment thread README.es-ES.md
Comment on lines +56 to +72
```js
import React from 'react';
import { useQuery } from '@apollo/react-hooks';

import withApollo from 'hocs/withApollo';

const QUERY = gql`
query Profile {
profile {
name
displayname
}
}
`;

const ProfilePage = () => {
const { loading, error, data } = useQuery(PROFILE_QUERY);

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Make the basic query example executable.

The snippet uses gql without importing it. It declares QUERY but passes PROFILE_QUERY to useQuery. A reader copying this example will get undefined identifiers. Add the project’s gql import and use QUERY, or rename the declaration.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.es-ES.md` around lines 56 - 72, Update the ProfilePage example so its
identifiers are defined and consistent: import the project’s gql helper
alongside the existing imports, and pass the declared QUERY constant to useQuery
instead of the undefined PROFILE_QUERY.

Comment thread README.es-ES.md
Comment on lines +98 to +100
```
export default withApollo(ProfilePage, { ssr: false });
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Specify the code fence language.

Change the fence at Line 98 to ```js to satisfy Markdown linting and preserve syntax highlighting.

🧰 Tools
🪛 markdownlint-cli2 (0.23.1)

[warning] 98-98: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.es-ES.md` around lines 98 - 100, Update the Markdown code fence
surrounding the withApollo(ProfilePage, { ssr: false }) example in
README.es-ES.md to specify the JavaScript language using a js fence, while
preserving the example content.

Source: Linters/SAST tools

Comment thread README.es-ES.md
Comment on lines +145 to +151
const createApolloClient = ({ initialState, headers = {} }) => {
const authLink = () => setContext(attachAuth(headers));

const httpLink = new HttpLink({
credentials: 'include',
uri: GRAPHQL_ENDPOINT,
fetch

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Define the authenticated GraphQL endpoint.

The example references GRAPHQL_ENDPOINT at Line 150, but does not declare it. The earlier example declares a different constant, GRAPHQL_URL. Define GRAPHQL_ENDPOINT in this example or use the existing endpoint constant.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.es-ES.md` around lines 145 - 151, Update the createApolloClient
example to resolve the undefined GRAPHQL_ENDPOINT reference by reusing the
existing GRAPHQL_URL constant or declaring GRAPHQL_ENDPOINT before the HttpLink
configuration.

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.

1 participant