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

[Hydrogen reference docs]: Specify /hydrogen repo in comments #165

Merged
merged 1 commit into from
Nov 9, 2021
Merged

[Hydrogen reference docs]: Specify /hydrogen repo in comments #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/generate-docs/src/FileResult.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class FileResult {
public async writeDevDoc(path: string) {
const result = inPageAnchors(this.staged.join(''));

const comment = `<!-- This file is generated from the source code and any changes you make here will be overwritten. -->`;
const comment = `<!-- This file is generated from source code in the Shopify/hydrogen repo. Any changes you make here will be overwritten. -->`;

await this.write(path, [this.frontMatter, comment, result].join('\n\n'));
}
Expand All @@ -38,7 +38,7 @@ export class FileResult {

const localPath = path.replace(resolve('.'), '');
const finalPath = resolve(path, 'README.md');
const comment = `<!-- This file is generated from the source code. Edit the files in ${localPath} and run 'yarn generate-docs' at the root of this repo. -->`;
const comment = `<!-- This file is generated from source code in the Shopify/hydrogen repo. Edit the files in ${localPath} and run 'yarn generate-docs' at the root of this repo. -->`;
await this.write(
finalPath,
[comment, ...this.staged].join('\n\n').trim()
Expand Down