Skip to content

feat: Refine api reference docs generation process #8229

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 15 commits into from
Mar 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 0 additions & 50 deletions .github/workflows/update_references.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ public/**/**/nextImageExportOptimizer/
public/next-image-export-optimizer-hashes.json
src/directory/directory.json
src/directory/flatDirectory.json
src/references/raw-references.json

#amplify-do-not-edit-begin
amplify/\#current-cloud-backend
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@
"prepare": "husky install",
"analyze": "ANALYZE=true yarn next-build",
"prebuild": "node src/directory/generateDirectory.mjs && node src/directory/generateFlatDirectory.mjs",
"lint": "next lint"
"lint": "next lint",
"clean-references": "node tasks/clean-references.mjs"
},
"packageManager": "yarn@1.22.22"
}
2 changes: 1 addition & 1 deletion src/components/ApiDocs/FunctionReturn.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { View } from '@aws-amplify/ui-react';
import { MDXHeading } from '../MDXComponents';
import { Promise } from './display/Promise';
import { ApiComment } from './ApiComment';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';
import { ParameterType } from './display';

export const FunctionReturn = ({ functionReturn, sigName }) => {
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/FunctionSignature.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { ApiComment } from './ApiComment';
import { Parameters } from './Parameters';
import { Throws } from './Throws';
import { FunctionReturn } from './FunctionReturn';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';

export const FunctionSignature = ({ sig }) => {
const sigObject = references[sig];
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/Parameters.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { View } from '@aws-amplify/ui-react';
import { MDXHeading, MDXTable } from '../MDXComponents';
import { ApiComment } from './ApiComment';
import { ParameterType } from './display';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';

export const Parameters = ({ parameters, sigName }) => {
const paramObjects = parameters.map((id) => references[id]);
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/ReferencePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Fragment } from 'react';
import { FunctionReference } from './FunctionReference';
import { Divider, View, Flex } from '@aws-amplify/ui-react';
import { API_CATEGORIES, API_SUB_CATEGORIES } from '@/data/api-categories.mjs';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';
import { MDXHeading } from '../MDXComponents';

export const ReferencePage = ({ category }) => {
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/display/ApiModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { IconX } from '../../Icons';
import { ParameterType } from './ParameterType';
import { ApiComment } from '../ApiComment';
import { LinkDataType, TypeLinkInterface } from './TypeLink';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';
import { useRef } from 'react';

interface ApiModalInterface {
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/display/ParameterType.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { View } from '@aws-amplify/ui-react';
import { TypeLink } from './TypeLink';
import { LinkDataType } from './TypeLink';
import React from 'react';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';

interface typeDataType {
typeArguments?: LinkDataType[];
Expand Down
2 changes: 1 addition & 1 deletion src/components/ApiDocs/display/TypeLink.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { useContext } from 'react';
import { TypeContext } from '@/components/ApiDocs/ApiModalProvider';
import { View } from '@aws-amplify/ui-react';
import references from '@/directory/apiReferences.json';
import references from '@/directory/apiReferences/amplify-js.json';

export interface LinkDataType {
name: string;
Expand Down
2 changes: 2 additions & 0 deletions src/data/api-categories.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ export const API_SUB_CATEGORIES = {
'rest-api': 'api',
'in-app-messaging': 'in-app-messaging'
};

export const ROOT_PACKAGE = 'aws-amplify';
Loading