Fix GraphQL Queries related to OrganizationDashboard.jsx
#3534
Conversation
WalkthroughThe changes introduce a robust update to the GraphQL schema by adding a new Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant GraphQLServer
participant DB
Client->>GraphQLServer: GET_ORGANIZATION_DATA_PG
GraphQLServer->>DB: Query OrganizationPg data
DB-->>GraphQLServer: Return organization details
GraphQLServer-->>Client: Deliver organization data
Client->>GraphQLServer: GET_ORGANIZATION_MEMBERS_PG
GraphQLServer->>DB: Query organization members
DB-->>GraphQLServer: Return members list
GraphQLServer-->>Client: Deliver members data
Client->>GraphQLServer: GET_ORGANIZATION_POSTS_PG
GraphQLServer->>DB: Query organization posts
DB-->>GraphQLServer: Return posts info
GraphQLServer-->>Client: Deliver posts data
Client->>GraphQLServer: GET_ORGANIZATION_EVENTS_PG
GraphQLServer->>DB: Query organization events
DB-->>GraphQLServer: Return events list
GraphQLServer-->>Client: Deliver events data
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Poem
Tip 🌐 Web search-backed reviews and chat
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
hustlernik
changed the title
OrganizationDashboard.jsxOrganizationDashboard.jsx
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (12)
src/screens/OrganizationDashboard/OrganizationDashboard.tsx (3)
9-13: Consolidate Query Imports
All the new queries (GET_ORGANIZATION_MEMBERS_PG,GET_ORGANIZATION_POSTS_COUNT_PG,GET_ORGANIZATION_EVENTS_PG,GET_ORGANIZATION_POSTS_PG) appear logically grouped. However, consider grouping them together for improved readability, especially if any additional queries are added in the future.
50-50: Re-check necessity of commented out translations
The commented-out translation hook (t: tErrors) might be needed if you plan to re-introduce error handling. Leaving commented-out code can create clutter; consider removing it or adding a TODO annotation if it will be brought back soon.
65-65: Remove leftover commented-out code
These lines referencingdayjsand other code (leaderboard links, etc.) remain commented out. If they are no longer needed, removing them helps keep the file clean and consistently maintained.Also applies to: 67-67
src/utils/interfaces.ts (3)
293-293: Confirm usage of mixed numeric/string ID type
Declaringtype ID = string | number;can cause unintended type-collisions. If the GraphQL layer always returns strings, you might prefer to keep this asstringfor consistency and to avoid confusion.
523-545: Standardize date/time field types
Some fields (e.g.,birthDate,createdAt,updatedAt) are typed asDate, while others are typed asstring. Consider internal consistency throughout the codebase for better clarity and to avoid runtime parsing errors.Also applies to: 821-822
808-848: Clarify top-level vs. nested property
InterfaceOrganizationPgwrapsorganizationas a nested property. Confirm that this aligns with your GraphQL schema usage. A simpler structure might export the fields at the top level.src/components/Avatar/Avatar.tsx (1)
7-7: Handle undefined name gracefully
Changingnameto optional means the DiceBear avatar could default to a blank seed. Consider using a fallback (e.g., a default name or initials) whennameis absent to ensure consistent visuals.- seed: name, + seed: name || 'Guest',src/components/LeftDrawerOrg/LeftDrawerOrg.tsx (1)
55-91: Consider keeping state management for better control.While removing the state management simplifies the code, consider keeping it for better control over the organization data lifecycle and potential optimizations.
- // const [organization, setOrganization] = useState<InterfaceOrganizationPg>(); + const [organization, setOrganization] = useState<InterfaceOrganizationPg>(); const { data, loading } = useQuery(GET_ORGANIZATION_DATA_PG, { variables: { id: orgId }, }); + useEffect(() => { + let isMounted = true; + if (data && isMounted) { + setOrganization(data?.organization); + } + return () => { + isMounted = false; + }; + }, [data]);src/GraphQl/Queries/Queries.ts (1)
444-462: Consider adding pagination info for posts query.The posts query includes
firstparameter but lacks cursor-based pagination fields that are present in other queries.export const GET_ORGANIZATION_POSTS_PG = gql` - query GetOrganizationPosts($id: String!, $first: Int) { + query GetOrganizationPosts($id: String!, $first: Int, $after: String) { organization(input: { id: $id }) { - posts(first: $first) { + posts(first: $first, after: $after) { edges { node { id caption createdAt creator { id name } } + cursor } + pageInfo { + hasNextPage + endCursor + } } } } `;schema.graphql (3)
774-862: [OrganizationPg Type Definition Review]
The newOrganizationPgtype is well structured and captures a broad set of fields—including basic organizational details (ID, name, description, address fields) and metadata (createdAt, updatedAt, creator, updater). It also defines several connection fields (advertisements, chats, events, funds, members, pinnedPosts, posts, tagFolders, tags, venues) with pagination arguments.Recommendations:
- Consider reviewing the nullability of key fields (e.g.
name) to ensure required fields are enforced where needed.- Evaluate whether the argument types (e.g. using
Intfor first/last) should be more strictly constrained (perhaps using a custom scalar likePositiveInt) for consistency across the schema.🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
881-890: [AdvertisementTypePg Enum Review]
The newenum AdvertisementTypePgis introduced with valuesbanner,menu, andpop_up.Observations:
- These enum values are specified in lowercase, which differs from the typical uppercase convention seen elsewhere in the schema (e.g.
BANNER,MENU,POPUPin the originalAdvertisementType).- If this change is intentional to reflect a new naming convention, ensure that the front-end and resolvers are updated accordingly; otherwise, consider using uppercase values for consistency.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
973-1079: [Event and Agenda Types Review]
The new types for event connections and agenda functionality (e.g.OrganizationEventsConnectionPg,OrganizationEventsConnectionEdgePg,EventAttachmentPg,EventAgendaFoldersConnectionPg,EventAgendaFoldersConnectionEdgePg,AgendaFolderChildFoldersConnectionPg,AgendaFolderChildFoldersConnectionEdgePg,AgendaFolderItemsConnectionPg,AgendaFolderItemsConnectionEdgePg,AgendaItemTypePg,AgendaItemPg,AgendaFolderPg, andEventPg) are comprehensive and detailed.Observations & Recommendations:
- The hierarchy appears to be: an
EventPgcan have multiple agenda folders (AgendaFolderPg), and each agenda folder can have child folders and items.- In
AgendaItemPg(lines 1025–1037), the fieldis slightly ambiguous. Since an agenda item is likely part of an agenda folder, renaming this field to something likeevent: AgendaFolderPgfoldermight better convey its role.- Ensure that the relationship between
AgendaFolderPgandEventPg(where the folder contains aneventfield) is clearly documented so that consumers of the API understand the data flow.🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
schema.graphql(1 hunks)src/GraphQl/Queries/Queries.ts(1 hunks)src/components/Avatar/Avatar.tsx(1 hunks)src/components/LeftDrawerOrg/LeftDrawerOrg.tsx(5 hunks)src/components/OrgListCard/OrgListCard.tsx(3 hunks)src/components/OrganizationDashCards/CardItem.tsx(2 hunks)src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx(5 hunks)src/screens/OrganizationDashboard/OrganizationDashboard.tsx(15 hunks)src/utils/interfaces.ts(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx
🧰 Additional context used
🪛 GitHub Actions: PR Workflow
schema.graphql
[error] File is unauthorized to change/delete.
🔇 Additional comments (17)
src/screens/OrganizationDashboard/OrganizationDashboard.tsx (1)
218-218: Check combined loading condition
UsingorgMemberLoading || orgPostsLoading || orgEventsLoadingwill display loading placeholders if any query is still in progress. Confirm that partial data doesn’t need to be rendered while other queries load.src/components/OrganizationDashCards/CardItem.tsx (2)
20-23: LGTM! Interface update aligns with standardization efforts.The changes to the
creatorproperty inInterfaceCardIteminterface simplify the representation of creator information by using a singlenamefield instead of separatefirstNameandlastNamefields.
68-68: LGTM! Updated creator name rendering.The rendering of the creator's name has been correctly updated to use the new
namefield.src/components/OrgListCard/OrgListCard.tsx (2)
10-10: LGTM! Added React Router navigation hook.The addition of
useNavigatehook is appropriate for handling navigation in React Router.
30-31: LGTM! Improved navigation implementation.The navigation logic has been correctly implemented:
- Destructuring
idfrom props- Using
useNavigatehook- Constructing and navigating to the organization dashboard URL
Also applies to: 32-32, 41-44
src/components/LeftDrawerOrg/LeftDrawerOrg.tsx (2)
3-3: LGTM! Updated GraphQL query import.The import statement has been correctly updated to use the new paginated organization query.
128-162: LGTM! Updated rendering logic with proper error handling.The component correctly handles loading and error states while rendering organization data using the new structure.
src/GraphQl/Queries/Queries.ts (5)
388-395: LGTM! Added query for organization posts count.The query is well-structured and follows GraphQL best practices.
397-415: LGTM! Added paginated query for organization members.The query correctly implements cursor-based pagination with proper page info fields.
417-442: LGTM! Added paginated query for organization events.The query includes all necessary fields and implements proper pagination.
464-473: LGTM! Added query for basic organization data.The query includes essential fields needed for the organization dashboard.
475-528: LGTM! Updated organization query.The query has been correctly updated to fetch a single organization by ID.
schema.graphql (5)
887-905: [Advertisement Attachment and Core Type Review]
The typesAdvertisementAttachmentPgandAdvertisementPgare defined to support new advertisement functionality.Observations:
AdvertisementPgcorrectly makes use of the newAdvertisementTypePgenum and includes fields for the name, description, dates, metadata, and attachments.- These types appear to be consistent with the overall design of the new "Pg" types.
Ensure that any changes on the front-end that consume these fields are updated accordingly.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
907-971: [Chat Connection Types Review]
The new chat-related types—includingOrganizationChatsConnectionPg,OrganizationChatsConnectionEdgePg,ChatMembersConnectionPg,ChatMembersConnectionEdgePg,ChatMessagesConnectionPg,ChatMessagePg,ChatMessagesConnectionEdgePg, andChatPg—are structured consistently with the connection pattern used elsewhere.Observations:
- Each connection type accepts pagination arguments and returns the appropriate connection edge and node.
ChatPgencapsulates fields such as name, description, avatars, and nested connection fields (membersandmessages), which should support the requirements for chat queries.Overall, these definitions look solid; just verify that the corresponding GraphQL resolvers support these fields and nested queries effectively.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
1105-1154: [Member, Pinned Post, and Post Types Review]
The new types for organization members (OrganizationMembersConnectionPg), pinned posts (OrganizationPinnedPostsConnectionPg), and posts (PostPgandOrganizationPostsConnectionPg) are introduced with connection patterns similar to the rest of the schema.Observations:
- The
OrganizationPinnedPostsConnectionPgtype usespageInfo: PageInfo!instead ofPageInfoPg!as in other connection types. Please confirm if this is intentional or a typographical error that requires alignment with other new connection types.- Aside from this inconsistency, the definitions for posts and members appear well aligned with the overall schema design.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
1223-1259: [Venue Types Review]
The new venue-related types (OrganizationVenuesConnectionPg,OrganizationVenuesConnectionEdgePg,VenueAttachmentPg,VenueEventsConnectionPg,VenueEventsConnectionEdgePg, andVenuePg) follow the established pattern for connection and node types.Observation:
- These definitions appear clear and consistent with the connection patterns used elsewhere. Just verify that any resolvers for venue queries accommodate these types appropriately.
🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
864-1259:⚠️ Potential issue[Connection & Pagination Types Review]
The set of pagination and connection types (starting withPageInfoPgand including various connection and edge types for advertisements, chats, events, agenda folders/items, funds, members, posts, tag folders, tags, and venues) generally follows a consistent pattern.Observations & Recommendations:
- The
PageInfoPgtype (lines 864–869) is clear and mirrors common connection patterns.- In
OrganizationPinnedPostsConnectionPg(lines 1115–1124), note that thepageInfofield is typed asPageInfo!whereas the other connections usePageInfoPg!. Please verify if this discrepancy is intentional or should be aligned.- In
FundPg(lines 1092–1102), the fieldreferences a typecampaigns(after: String, before: String, first: Int, last: Int): FundCampaignsConnectionPgFundCampaignsConnectionPgthat is not defined in this file. This missing type definition is critical and needs to be addressed.- In
TagFolderPg(lines 1175–1186), the fieldalso references an undefined type (tags(after: String, before: String, first: Int, last: Int): TagFolderTagsConnectionPgTagFolderTagsConnectionPg). Please add this type or update the reference accordingly.Overall, while the connection and edge types are consistently structured, please resolve the noted missing types and check the
pageInfoinconsistency before merging.🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] File is unauthorized to change/delete.
palisadoes
added
the
ignore-sensitive-files-pr
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3534 +/- ##
====================================================
- Coverage 88.75% 85.69% -3.06%
====================================================
Files 341 342 +1
Lines 8632 8881 +249
Branches 1927 1911 -16
====================================================
- Hits 7661 7611 -50
- Misses 636 930 +294
- Partials 335 340 +5 ☔ View full report in Codecov by Sentry. |
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md (1)
5-7:🧩 Analysis chain
Ensure Naming Consistency for the GraphQL Variable.
The header and declaration still refer to
ORGANIZATIONS_LIST, yet recent changes indicate that the query has been renamed toORGANIZATION_LISTin the source code. Please verify that the documentation is aligned with the new naming convention for clarity and consistency across the project.A suggested diff if the rename is intended:
-# Variable: ORGANIZATIONS_LIST + # Variable: ORGANIZATION_LISTand
-> Replace: -> `const` **ORGANIZATIONS_LIST**: `DocumentNode` +> `const` **ORGANIZATION_LIST**: `DocumentNode`
🏁 Script executed:
#!/bin/bash # Display the content of the documentation file to check the current naming echo "=== Content of docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md ===" cat docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md # Search the codebase for the new naming "ORGANIZATION_LIST" echo "=== Searching for 'const ORGANIZATION_LIST' in the repository ===" rg "const ORGANIZATION_LIST" # Search the codebase for the old naming "ORGANIZATIONS_LIST" echo "=== Searching for 'const ORGANIZATIONS_LIST' in the repository ===" rg "const ORGANIZATIONS_LIST"Length of output: 1212
Update Documentation Naming for GraphQL Query Variable
- The docs file (docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md) still refers to the variable as ORGANIZATIONS_LIST.
- In the code, a new variable is declared as ORGANIZATION_LIST (as shown in src/GraphQl/Queries/Queries.ts).
- This mismatch can lead to confusion. Please update the markdown file to reflect the singular name (
ORGANIZATION_LIST) for clarity.
🧹 Nitpick comments (35)
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionEdgePg.md (2)
5-8: Suggestion: Add a Brief Overview of the Interface PurposeWhile the header and defined location are clear, adding a short description of what the InterfaceOrganizationMembersConnectionEdgePg represents (e.g., its role within organization members connections) could improve clarity for readers.
17-24: Review: Enhance Node Property DescriptionThe "node" property documentation correctly links to the InterfaceUserPg definition. To further assist readers, consider adding a brief explanation of what this node property represents within the connection edge context.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md (1)
39-39: Updated Property Reference for pledgeStartDate:
The link on line 39 now correctly refers to the new location (line 1188) for pledgeStartDate. Note that in the documentation the order places pledgeEndDate before pledgeStartDate, which may differ from the order in the source file. Consider verifying if aligning the order with the source would enhance clarity.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionPg.md (3)
5-7: Header and Context Enhancement
The header clearly identifies the interface and provides a link to its definition. For improved clarity, consider adding a brief summary of the interface’s purpose immediately following the header. This extra context can help developers understand the role of the interface without navigating to the source.Example diff suggestion:
@@ After line 7 -Defined in: [src/utils/interfaces.ts:707](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L707) +Defined in: [src/utils/interfaces.ts:707](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L707) + +This interface represents the connection structure for an organization's pinned posts, +providing access to both the list of post edges and related pagination information.
11-15: Property "edges" Documentation
The documentation for "edges" is concise and includes a hyperlink to the detailed definition ofInterfaceOrganizationPinnedPostsConnectionEdgePg. For enhanced clarity, consider adding a brief description of what "edges" represent (e.g., the list of pinned post connections).
19-23: Property "pageInfo" Documentation
The "pageInfo" property is documented clearly with a direct link to further details aboutInterfacePageInfoPg. Including a brief note on what pagination details (such as current page, total count, etc.) this property encompasses could further assist readers.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionPg.md (1)
9-16: Review the 'edges' Property Documentation.
The documentation for theedgesproperty is concise and includes a link to theInterfaceOrganizationMembersConnectionEdgePgdetails. The use of square brackets ([]) suggests thatedgesis an array, which is good. Consider expanding the description with any additional details or examples if further clarification is needed in the future.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionPg.md (1)
9-16: Property Documentation: EdgesThe "edges" property is documented with its type as an array of
InterfaceOrganizationTagFoldersConnectionEdgePgobjects and a link to its documentation file.
• However, note the trailing "[]" after the link in line 13. This appears unnecessary and could be removed to clean up the markdown.
Suggested diff:-> **edges**: [`InterfaceOrganizationTagFoldersConnectionEdgePg`](InterfaceOrganizationTagFoldersConnectionEdgePg.md)[] +> **edges**: [`InterfaceOrganizationTagFoldersConnectionEdgePg`](InterfaceOrganizationTagFoldersConnectionEdgePg.md)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_PG.md (2)
5-7: Clear Variable Declaration Documentation
The header clearly identifies the variable "GET_ORGANIZATION_POSTS_PG" and its type ("DocumentNode"), and the formatting effectively emphasizes the key details. Consider verifying whether escaping underscores (using "_") is necessary with your markdown renderer—it might be optional.
1-10: Suggestion for Enhanced Context
To further improve the documentation, consider adding a brief description that explains the purpose of the "GET_ORGANIZATION_POSTS_PG" query. For example, a short summary of what posts are retrieved by this query and any parameters it might leverage could benefit future maintainers or users of the documentation.docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/MOCKS.md (1)
7-7: Streamline Type Definitions for the MOCKS ConstantThe updated type signature in line 7 clearly consolidates the organization data under a single object and introduces the new
aftervariable along with mandatoryfirstandidfields. This aligns well with the updated GraphQL schema and the new query requirements for OrganizationDashboard.However, a couple of refinement suggestions:
- The union type, while explicit, is quite verbose. Consider defining dedicated TypeScript interfaces or type aliases (e.g., an
OrganizationMocktype) in your source code for improved maintainability and readability.- The use of
anyfor theaftervariable might be acceptable if its structure is unknown, but if possible, replace it with a more specific type such asstring | nullto catch potential type issues earlier.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionPg.md (3)
5-8: Interface Header and Source ReferenceThe interface title and the "Defined in:" link clearly indicate where this interface is implemented. This helps users quickly locate the source in the repository.
Consider adding a brief one-line summary of the interface’s purpose beneath the title to enhance context.
9-16: Documentation for 'edges' PropertyThe documentation for the "edges" property is well-structured:
• It specifies the type using a markdown link toInterfaceOrganizationPostsConnectionEdgePg.mdand
• Provides a direct reference to the source definition ([src/utils/interfaces.ts:732]).
For additional clarity, consider including a short description of what the "edges" array represents (e.g., the collection of post connection edges).
17-23: Documentation for 'pageInfo' PropertyThe "pageInfo" property is documented with a clear type link to
InterfacePageInfoPg.mdand a source reference ([src/utils/interfaces.ts:733]).
While the technical details are covered, a brief descriptive sentence about the role of pagination information in the context of organization posts could improve the overall clarity.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionEdgePg.md (1)
9-16: Documentation for the “cursor” PropertyThe documentation for the “cursor” property (lines 9–16) clearly outlines its type (
string) and includes a direct link to its source definition. Consider adding a brief description of what the cursor represents if additional context would benefit users.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionPg.md (1)
9-16: Documentation for the "edges" PropertyThe “edges” property (lines 9–16) is documented to reference an array of
InterfaceOrganizationFundsConnectionEdgePg. However, the markdown notation shows an extra pair of brackets after the link (i.e.[...][]). If the intent is to denote an array type, consider explicitly writing it asInterfaceOrganizationFundsConnectionEdgePg[]for clarity.docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md (1)
7-7: Clarify and Document the Union Type StructureThe updated type definition for ERROR_MOCKS now enforces
firstas a number and introduces anafterproperty (with typeanyorundefinedin different branches). Although this change streamlines the definition by removing the previously optional properties (organization_id,orgId, andwhere), the union still appears complex. For enhanced readability and maintainability, consider adding inline comments or a brief documentation note that describes the intent behind each branch of the union and why, for example, some cases haveafterdefined while others do not.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_COUNT_PG.md (1)
7-8: Detailed Variable Declaration
The markdown block quoting “>constGET_ORGANIZATION_POSTS_COUNT_PG:DocumentNode” is well formatted and clearly shows the variable’s declaration and type. For improved clarity, consider adding a brief description below this line to explain the purpose or usage context of this variable.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionPg.md (1)
9-16: “edges” Property Array Notation Clarity
The “edges” property is meant to be an array of InterfaceOrganizationVenuesConnectionEdgePg objects. The notation currently shows
> edges:InterfaceOrganizationVenuesConnectionEdgePg[]
Consider revising it for clarity—for example, using inline array notation as:
> edges:InterfaceOrganizationVenuesConnectionEdgePg[](InterfaceOrganizationVenuesConnectionEdgePg)
This small refinement would improve readability.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionPg.md (1)
11-16: Edges Property Documentation EnhancementThe documentation for the "edges" property is well-structured and includes a link to the corresponding interface document. However, the trailing square brackets "[]" may be confusing. If these brackets are intended to denote an array type, consider integrating them within the inline code styling. For example, you could update the line to:
- > **edges**: [`InterfaceOrganizationAdvertisementsConnectionEdgePg`](InterfaceOrganizationAdvertisementsConnectionEdgePg.md)[] + > **edges**: [`InterfaceOrganizationAdvertisementsConnectionEdgePg[]`](InterfaceOrganizationAdvertisementsConnectionEdgePg.md)This change would more clearly indicate that "edges" is an array of
InterfaceOrganizationAdvertisementsConnectionEdgePg.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatMessagePg.md (2)
1-4: Admin Docs Header Review:
The header section begins with a link labeled "Admin Docs". Ensure that the target ("/") is the intended location, or consider updating it to point directly to a more relevant documentation landing page if necessary.
51-56: Property 'parentMessage' Documentation:
The documentation for "parentMessage" includes a self-referential link toInterfaceChatMessagePg.md. This can be a useful reference for recursive data structures but might confuse some readers. Consider adding a clarifying note to explain that this property supports threaded message structures by referencing a parent message.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatPg.md (1)
1-88: Overall Documentation Quality and Structure:
This new file is comprehensive and well-structured, providing detailed type information and source references for every property of theInterfaceChatPginterface. One suggestion for further enhancement: consider adding a brief introductory summary that explains the overall purpose and usage of theInterfaceChatPginterface. This extra context could help developers understand how this interface fits into the broader system architecture.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md (2)
31-31: Documentation Update: 'isArchived' Property Reference
The reference for isArchived is now updated to line 1143. Please verify that the order of properties in the documentation aligns with their order in the source file, as this can further enhance clarity for maintainers.
39-39: Documentation Update: 'isDefault' Property Reference
The updated link for isDefault now correctly points to src/utils/interfaces.ts:1142. Note that in the documentation, isDefault is presented after isArchived, even though its actual declaration line (1142) precedes isArchived (1143). Consider reviewing the intended order in the source file and documentation to ensure consistency.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md (1)
51-51: Reference Update: Name Property.
The documentation for thenameproperty is updated to point to line 1020. Note that there appear to be twonamesections in this document. If these refer to distinct parts of the interface, additional clarification in the docs might be beneficial to avoid confusion.docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePaginationArgs.md (2)
11-17: "after" Property DocumentationThe documentation for the "after" property is well-structured: it includes both a clear type declaration (
string) and a link to its definition in the source file.
Consider adding a brief explanation of how this property is used in pagination (e.g., as a cursor for forward pagination) to enhance clarity.
19-24: "before" Property DocumentationSimilar to the "after" property, the "before" property is documented cleanly with its type and a reference link.
A short note describing its usage (e.g., supporting backward pagination) could further improve the documentation.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md (1)
39-39: Review the Ordering of Documentation SectionsThe property "show" now references src/utils/interfaces.ts:1223, which is correct. However, consider verifying whether the order in the documentation should mirror the source file’s order (i.e. if "show" is defined immediately after the interface or before the methods). Aligning the documentation order with the source may improve clarity for readers.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionPg.md (1)
11-16: Property "edges" Documentation is Detailed but Check Markdown SyntaxThe documentation for the "edges" property is well written and includes a link to
InterfaceOrganizationTagsConnectionEdgePg. Note the trailing "[]" in the markdown link—please verify if this is intentional or if it should be removed to avoid potential formatting issues.docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md (1)
7-8: Complex Union Type Declaration: Consider Simplification and ClarificationThe new union type for EMPTY_MOCKS is comprehensive and aligns with the updated mocks. However, its complexity might reduce readability and maintainability over time. It may be beneficial to consider:
- Using optional properties (e.g., "id?: string" instead of explicitly setting properties to "undefined") to simplify type definitions.
- Introducing inline comments for each union variant to explain their distinct purposes, which could help future maintainers understand the rationale behind each case.
docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md (2)
11-2000: Uniform Format Across All Enumeration Entries & Maintenance Considerations
Every enumeration member is documented following the same format (header, blockquote with code, and a “Defined in:” reference). This uniformity improves the overall readability and assists developers in quickly locating the source of each entry.
• Consider including a table of contents or an index at the top of the document if users need to navigate through hundreds of entries.
• As the list is very long, if this documentation is generated automatically from the TypeScript file, it might be beneficial to include a comment at the top to indicate that manual edits might be overwritten.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L14) *** ### aw > aw:"aw"Defined in: [src/utils/inter...(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~523-~523: The abbreviation “e.g.” (= for example) requires two periods.
Context: .../src/utils/interfaces.ts#L65) *** ### eg > eg:"eg"Defined in: [src/uti...(E_G)
[uncategorized] ~533-~533: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L66) *** ### eh > eh:"eh"Defined in: [src/utils/inter...(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~773-~773: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L96) *** ### hm > hm:"hm"Defined in: [src/utils/inter...(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~1173-~1173: Interjections are usually punctuated.
Context: ...s/interfaces.ts#L146) *** ### mm > mm:"mm"Defined in: [src/utils/inter...(INTERJECTIONS_PUNCTUATION)
117-117: Static Analysis Warning Regarding Punctuation – False Positives in Context
Static analysis tools have flagged several lines (e.g. those corresponding to entries such as “aw”, “eh”, “hm”, and “mm”) for interjection punctuation and abbreviation formatting issues. In this context, these entries represent ISO country codes and are intentionally documented as literal strings. These warnings can be safely ignored or suppressed in the auto-generated documentation.Also applies to: 523-523, 533-533, 773-773, 1173-1173
🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L14) *** ### aw > aw:"aw"Defined in: [src/utils/inter...(INTERJECTIONS_PUNCTUATION)
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPg.md (1)
37-40: Enhance Consistency for the 'chats' Property
Thechatsproperty is currently documented as plain text (InterfaceOrganizationChatsConnectionPg), whereas similar properties use clickable markdown links. Consider converting this to a markdown link (e.g.,InterfaceOrganizationChatsConnectionPg) for consistency, assuming corresponding documentation is available.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementPg.md (1)
9-16: “attachments” Property Documentation:
The “attachments” property is documented with a markdown link to the InterfaceAdvertisementAttachmentPg documentation and indicates it is an array (denoted by the trailing “[]”).
• Nitpick: Consider clarifying the array notation—if the intent is to denote an array type, you might explicitly show it as “InterfaceAdvertisementAttachmentPg[]” (while preserving the clickable link) to improve clarity for readers.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (107)
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ADMIN_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/BLOCK_PAGE_MEMBER_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_DATA_PG.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_PG.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_MEMBERS_PG.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_COUNT_PG.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_PG.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/SIGNIN_QUERY.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md(1 hunks)docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md(1 hunks)docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md(1 hunks)docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md(1 hunks)docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md(1 hunks)docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardPropsPG.md(2 hunks)docs/docs/auto-docs/components/OrganizationDashCards/CardItem/functions/default.md(1 hunks)docs/docs/auto-docs/components/OrganizationDashCards/CardItem/interfaces/InterfaceCardItem.md(2 hunks)docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/functions/default.md(1 hunks)docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/interfaces/InterfaceUserSidebarOrgProps.md(1 hunks)docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboard/functions/default.md(1 hunks)docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md(1 hunks)docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md(1 hunks)docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/MOCKS.md(1 hunks)docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryList.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemInfo.md(3 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemList.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md(3 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementAttachmentPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryList.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemInfo.md(5 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemList.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatMessagePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCurrentUserTypePG.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventAttachmentPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md(3 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFormData.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md(4 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoTypePG.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionType.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionTypePG.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgInfoTypePG.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionEdgePg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePageInfoPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePaginationArgs.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md(5 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostPg.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md(11 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md(4 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md(1 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md(6 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md(2 hunks)docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md(1 hunks)
⛔ Files not processed due to max files limit (31)
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagFolderPg.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagPg.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserPg.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserTypePG.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVenuePg.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md
- docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md
- schema.graphql
- src/GraphQl/Queries/Queries.ts
- src/components/Avatar/Avatar.tsx
- src/components/LeftDrawerOrg/LeftDrawerOrg.spec.tsx
- src/components/LeftDrawerOrg/LeftDrawerOrg.tsx
- src/components/OrgListCard/OrgListCard.tsx
- src/components/OrganizationDashCards/CardItem.spec.tsx
- src/components/OrganizationDashCards/CardItem.tsx
- src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.spec.tsx
- src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx
- src/screens/OrgPost/OrgPost.spec.tsx
- src/screens/OrgPost/OrgPost.tsx
- src/screens/OrganizationDashboard/OrganizationDashboard.spec.tsx
- src/screens/OrganizationDashboard/OrganizationDashboard.tsx
- src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts
- src/screens/OrganizationVenues/OrganizationVenues.spec.tsx
- src/utils/interfaces.ts
🧰 Additional context used
📓 Learnings (2)
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md (1)
Learnt from: meetulr
PR: PalisadoesFoundation/talawa-admin#2398
File: src/utils/interfaces.ts:266-0
Timestamp: 2024-11-12T10:40:58.654Z
Learning: The `GetChildTags` query in `src/GraphQl/Queries/userTagQueries.ts` includes the `ancestorTags` field for each child tag.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md (1)
Learnt from: meetulr
PR: PalisadoesFoundation/talawa-admin#2398
File: src/utils/interfaces.ts:266-0
Timestamp: 2024-11-12T10:40:58.654Z
Learning: The `GetChildTags` query in `src/GraphQl/Queries/userTagQueries.ts` includes the `ancestorTags` field for each child tag.
🪛 LanguageTool
docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md
[uncategorized] ~117-~117: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L14) *** ### aw > aw: "aw" Defined in: [src/utils/inter...
(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~523-~523: The abbreviation “e.g.” (= for example) requires two periods.
Context: .../src/utils/interfaces.ts#L65) *** ### eg > eg: "eg" Defined in: [src/uti...
(E_G)
[uncategorized] ~533-~533: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L66) *** ### eh > eh: "eh" Defined in: [src/utils/inter...
(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~773-~773: Interjections are usually punctuated.
Context: ...ls/interfaces.ts#L96) *** ### hm > hm: "hm" Defined in: [src/utils/inter...
(INTERJECTIONS_PUNCTUATION)
[uncategorized] ~1173-~1173: Interjections are usually punctuated.
Context: ...s/interfaces.ts#L146) *** ### mm > mm: "mm" Defined in: [src/utils/inter...
(INTERJECTIONS_PUNCTUATION)
🔇 Additional comments (454)
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md (1)
7-7: Correct Interface Reference UpdateThe documentation has been updated to reference the new line number [1272] in src/utils/interfaces.ts correctly. Please ensure that other documentation references in this section and across similar files maintain consistency.
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_LIST.md (1)
9-10: Accurate Documentation Link UpdateThe link has been correctly updated to point to the new definition location at line 710 in src/GraphQl/Queries/Queries.ts. This update aligns the documentation with the changes introduced in the GraphQL queries enhancement and ensures that users are directed to the accurate source location.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md (2)
7-7: Validate Updated Definition LinkThe documentation now points to line 1192 in the source file. Please verify that this URL accurately reflects the current position of the
InterfaceQueryMembershipRequestsListItemdefinition insrc/utils/interfaces.tsand that it remains stable against future changes.
15-15: Confirm Updated Organizations Property LinkThe link for the
organizationsproperty has been updated to point to line 1193 insrc/utils/interfaces.ts. Ensure that this reference is accurate and that it corresponds correctly with the updated interface structure.docs/docs/auto-docs/components/OrganizationDashCards/CardItem/functions/default.md (1)
9-9: Documentation Update Validated
The documentation now correctly links to the new definition location of the default function in the source file (line 33). This update is clear and consistent with the recent refactoring of the source code.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionType.md (2)
7-7: Verify Interface Definition Link:
The updated link now points to line 462 in src/utils/interfaces.ts. Please double-check that this reference accurately reflects the new location of the interface definition and will remain valid as the file evolves.
15-15: Confirm Property Location Link:
The link for the organizationsConnection property is updated to reference line 463. This change aligns with the recent restructuring. Ensure that the link continues to be valid after future refactors.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCurrentUserTypePG.md (2)
7-7: Documentation Link Update for Interface Definition
The reference to the interface definition has been updated to point to line 324 of the source file. The updated link is clear and correctly reflects the new location.
15-15: Documentation Link Update for currentUser Property
The link for the definition of the currentUser property now points to line 325 in the source file. This update improves traceability between the documentation and the implementation.docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md (1)
9-9: Update Documentation Link to Reflect Correct Source Line
The updated link now accurately points to line 34 in the LeftDrawerOrg component source (as opposed to the previous line 35). Please verify that the source file has indeed been adjusted and the documentation accurately reflects the current state.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemList.md (2)
7-7: Updated Interface Definition Reference
The documentation now correctly points to the new location of the interface definition at [src/utils/interfaces.ts:391]. Please confirm that the link is functional and accurately reflects the migration.
15-15: Updated Property Definition Reference
The link for the actionItemsByOrganization property has been updated to point to [src/utils/interfaces.ts:392]. This ensures that users are directed to the correct property definition. Please verify that the new link corresponds with the actual change in the source file.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md (1)
9-9: Documentation Update on Variable PositionThe documentation now correctly shows that ORGANIZATIONS_MEMBER_CONNECTION_LIST is defined at line 577 of src/GraphQl/Queries/Queries.ts. This update ensures consistency with the source code changes, aligning the docs with the new definition location.
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md (1)
9-9: Documentation Update: Correct Reference to USERS_CONNECTION_LIST DefinitionThe updated link now correctly indicates that USERS_CONNECTION_LIST is defined in src/GraphQl/Queries/Queries.ts:849. This change aligns the documentation with the new source location. Please ensure that the link remains accurate as future modifications to the file could alter line numbers.
docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboard/functions/default.md (1)
9-9: Documentation Link Update is Correct.
The updated link now correctly reflects that the definition of the default() function is in "src/screens/OrganizationDashboard/OrganizationDashboard.tsx" at line 47. This change ensures that readers will be directed to the proper location in the source code.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md (2)
7-7: Accurate Reference to Updated Interface DefinitionThe link now correctly points to the updated definition in src/utils/interfaces.ts at line 875. This ensures the documentation is aligned with the current source location.
15-15: Corrected Source Reference for the 'posts' PropertyThis update accurately reflects the new position of the 'posts' property in the source file at line 876. Confirm that this change is consistent with the updated interface structure.
docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/functions/default.md (1)
9-9: Accurate Update of the Function Definition Reference.
The updated documentation now correctly points to the function definition in the TSX file at line 43. This update aligns with the recent changes in the component implementation.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ADMIN_LIST.md (1)
9-9: Reference Link Updated CorrectlyThe updated link now points to
src/GraphQl/Queries/Queries.ts:806as expected, reflecting the relocation of theADMIN_LISTdefinition. Ensure that the link remains valid if further changes affect the source file's structure.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoTypePG.md (2)
7-7: Updated Reference for Interface LocationThe documentation now correctly points to the new interface definition at src/utils/interfaces.ts:433. This update aligns with the codebase reorganization described in the PR objectives. Please ensure that future refactoring maintains the accuracy of these links.
15-15: Updated Reference for ‘node’ Property DefinitionThe “node” property documentation now accurately reflects its new location at src/utils/interfaces.ts:434. Verifying that this link continues to match the source file structure as the project evolves is recommended.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md (9)
7-7: Update Documentation Reference for InterfaceAddress
The documentation link for the InterfaceAddress definition has been updated to reflect the new source line [src/utils/interfaces.ts:1129]. This change ensures that users are directed to the correct location in the source code.
15-15: Update Documentation Reference for Property "city"
The reference for the "city" property now correctly points to [src/utils/interfaces.ts:1130]. This update aligns the documentation with the relocated source code.
23-23: Update Documentation Reference for Property "countryCode"
The "countryCode" property link has been updated to [src/utils/interfaces.ts:1131], reflecting the new location of its definition.
31-31: Update Documentation Reference for Property "dependentLocality"
The documentation now correctly shows the source reference as [src/utils/interfaces.ts:1132] for the dependentLocality property.
39-39: Update Documentation Reference for Property "line1"
The link for the "line1" property has been updated to point to [src/utils/interfaces.ts:1133]. This change maintains consistency with the new code location.
47-47: Update Documentation Reference for Property "line2"
The reference for "line2" was updated to [src/utils/interfaces.ts:1134], ensuring that the documentation accurately reflects the updated source code.
55-55: Update Documentation Reference for Property "postalCode"
The "postalCode" property now correctly references [src/utils/interfaces.ts:1135] in the documentation, as per the updated source file.
63-63: Update Documentation Reference for Property "sortingCode"
The documentation for "sortingCode" has been updated to [src/utils/interfaces.ts:1136], aligning it with the current source code structure.
71-71: Update Documentation Reference for Property "state"
The "state" property reference now correctly displays [src/utils/interfaces.ts:1137] as its location in the source code.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md (3)
7-7: Updated Source Reference for Interface DefinitionThe reference now accurately points to the new location of the interface in src/utils/interfaces.ts at line 1276. Ensure that if the interface moves further in future updates, these links remain synchronized.
15-15: Verified Documentation Link for Property "name"The link for the "name" property has been updated to reflect the new source location (line 1278) correctly. Maintaining accurate source references improves traceability.
23-23: Confirmed Updated Source Reference for Property "type"This change correctly updates the property "type" reference to line 1277 in the source file. It provides clarity on where the property is defined, and its accuracy is essential for users navigating the documentation.
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md (1)
9-9: Documentation Link Update VerifiedThe updated link now correctly points to the new definition location at line 621 in the source file. This update aligns with the changes in the GraphQL queries and overall query restructuring.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionEdgePg.md (2)
1-2: Review: Introductory Navigation Link is ClearThe "Admin Docs" link gives a quick way to navigate back to the main documentation homepage.
9-16: LGTM: Cursor Property DocumentationThe description for the "cursor" property, including its type and the reference link to the source code, is well-documented and clear.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md (2)
7-7: Accurate Reference for Interface Definition LocationThe documentation now correctly points to the new location of the InterfaceMembersList definition (line 395 in src/utils/interfaces.ts). This improves traceability and ensures consistency with the updated source code.
15-15: Accurate Reference for Organizations Property LocationThe updated reference now correctly indicates that the "organizations" property is defined at line 396 in src/utils/interfaces.ts. This update accurately reflects the changes in the source file.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md (2)
7-7: Interface Location Update Verified.The reference link now points to "src/utils/interfaces.ts:945", which matches the updated interface definition location as described in the PR objectives. The link appears correct and consistent.
15-15: Property Link Update Verified.The updated link for the "userTags" property now points to "src/utils/interfaces.ts:946". This update is consistent with the changes outlined in the PR and accurately reflects the new source location.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryList.md (2)
7-7: Verify Updated Interface Definition ReferenceThe "Defined in:" link has been updated to point to src/utils/interfaces.ts:1218. Please confirm that line 1218 is the correct start of the interface definition in the reorganized source file.
15-15: Confirm Updated Property Definition LinkThe property "agendaItemCategoriesByOrganization" now links to src/utils/interfaces.ts:1219. Verify that this updated location accurately reflects the new distribution of definitions in the source code.
docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA.md (1)
9-9: Documentation Link Update Verification.
The link in this line now points to line 938 in the source file, which aligns with the recent change in the query definition location. Please double-check that this actual location will remain consistent in future updates.docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md (1)
9-9: Update Function Definition ReferenceThe documentation has been correctly updated to reflect the new definition location of the default() function in OrgListCard at line 29. This ensures consistency between the source and its documentation.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md (4)
7-7: Update Documentation Link for Interface DefinitionThe reference now points to [src/utils/interfaces.ts:995], which correctly reflects the new location of the interface definition. Please verify that the link is live and accurate.
15-15: Update Campaigns Property LocationThe documentation for the "campaigns" property now references the new location at [src/utils/interfaces.ts:998]. Ensure this accurate update reflects the underlying code structure.
51-51: Update isArchived Property ReferenceThe "isArchived" property now correctly links to [src/utils/interfaces.ts:997]. Confirm that this updated reference aligns with the new organization of properties.
59-59: Update name Property LocationThe documentation now properly points to the new definition at [src/utils/interfaces.ts:996]. This update is consistent with the interface reorganization. Please double-check for accuracy.
docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md (5)
7-7: Update Interface Definition Link ReferenceThe link now points to line 17 in the component file, which appears to reflect the change accurately. Please verify that the referenced location in "src/components/LeftDrawerOrg/LeftDrawerOrg.tsx" now matches the current definition of the interface.
15-15: Update hideDrawer Property Link ReferenceThe updated reference to line 20 now correctly points to the new location of the hideDrawer property. This change aligns with the modifications made in the source file.
23-23: Update orgId Property Link ReferenceThe link has been modified to reference line 18 in the component file. This update correctly reflects the relocation of the orgId property.
31-31: Update setHideDrawer Property Link ReferenceThe documentation now references line 21 for the setHideDrawer property. This change properly aligns with the source file updates and should be correct.
39-39: Update targets Property Link ReferenceThe link has been updated to point to line 19, accurately reflecting the adjusted location of the targets property in the component file.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemList.md (2)
7-7: Updated Source Reference for Interface Definition
The reference indicating the new location of the InterfaceAgendaItemList in the source file now points to [src/utils/interfaces.ts:1268]. Please verify that this URL correctly reflects the updated file structure and that developers can navigate to the proper interface definition.
15-15: Updated Source Reference for Property Definition
The link for the property (agendaItemByEvent) has been updated to [src/utils/interfaces.ts:1269]. Ensure that this correctly corresponds to the property’s definition in the newly organized source file. If the new line number accurately reflects the current organization, this update will help maintain documentation consistency.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionTypePG.md (2)
7-7: Verify Updated Interface Definition LinkThe "Defined in:" link now points to line 466 in src/utils/interfaces.ts. Please confirm that this line number accurately reflects the new location of the InterfaceOrgConnectionTypePG definition. An incorrect link may mislead users reviewing the documentation.
15-15: Confirm Updated Property ReferenceThe "Defined in:" link for organizationsConnection now points to line 467 in src/utils/interfaces.ts. Ensure this reference correctly matches the actual location of the organizationsConnection property in the source file, maintaining consistency between the documentation and the code.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md (6)
7-7: Update Link for Interface Location
The updated link now points to src/utils/interfaces.ts at line 1324, which correctly reflects the new location of the InterfaceCreateVolunteerGroup definition.
15-15: Update Link for Property "description"
This change correctly updates the reference for the "description" property to line 1326 in the source file. The link is accurate and consistent with the codebase reorganization.
23-23: Update Link for Property "leader"
The link now points to the updated location (line 1327) where the "leader" property is defined. The documentation accurately reflects the changes made in the source file.
31-31: Update Link for Property "name"
The reference for the "name" property has been updated to line 1325. This change is consistent with the updated file structure and accurate.
39-39: Update Link for Property "volunteersRequired"
The documentation now correctly points to line 1328 for the "volunteersRequired" property definition. The update is well-aligned with the internal changes.
47-47: Update Link for Property "volunteerUsers"
The link for "volunteerUsers" has been updated to the new reference at line 1329. This ensures that users can locate the source of the property accurately.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionEdgePg.md (4)
1-4: Documentation Header and Navigation Link ClarityThe header section is well structured, providing an immediate navigational link with “Admin Docs”. The use of a horizontal rule (*** at line 3) clearly separates the header from the content.
5-8: Interface Title and Source ReferenceThe title clearly declares the documented interface, and the “Defined in” link accurately points to the source file at the proper line. This direct linkage helps developers quickly verify the implementation.
9-16: ‘cursor’ Property DocumentationThe “cursor” property is concisely documented with its type (
string) and an inline reference to its definition. The markdown formatting (blockquote and inline code) is appropriately applied, ensuring clarity.
17-24: ‘node’ Property Documentation and Link VerificationThe “node” property is documented clearly, linking to
InterfaceAdvertisementPgwith proper markdown formatting. Ensure that the linked file exists in the expected location and the reference remains valid as the project evolves.docs/docs/auto-docs/components/OrganizationDashCards/CardItem/interfaces/InterfaceCardItem.md (3)
19-22: Updated 'id' Property Documentation
The documentation now correctly indicates that the property formerly known as_idis renamed toidand its type is updated tostring | number. This change is consistent with the corresponding update in the source file, ensuring that users are aware of the more flexible type.
23-26: Renamed 'email' to 'name'
The removal of thenameproperty (of typestring) is accurately reflected in this section. This update aligns with the recent refactoring in the component, ensuring both documentation and implementation are in sync.
41-41: Updated 'location' Field Reference
The reference for thelocationproperty documentation has been updated to point to the new line number in the source file. This small but important update helps maintain consistency between the documentation and the source code location.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md (2)
1-8: Overall Documentation Structure is Consistent.The structure and formatting of the documentation are clear and well-organized, making it easy for readers to understand the context of the MEMBERS_LIST variable.
Also applies to: 10-10
9-9: Verification of Updated Definition Reference.The reference has been updated to point to [src/GraphQl/Queries/Queries.ts:531] as required by the reorganization of the GraphQL queries. Please double-check that this link accurately reflects the new location and remains valid as the codebase evolves.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md (5)
7-7: Updated Interface Definition Reference:
The "Defined in:" link on line 7 now correctly points to the new location of the interface definition in src/utils/interfaces.ts (line 1184). Ensure this link remains valid as further changes occur in the source file.
15-15: Updated Property Reference for pledgeAmount:
The updated "Defined in:" link on line 15 accurately reflects the new location (line 1186) of the pledgeAmount property.
23-23: Updated Property Reference for pledgeCurrency:
The link on line 23 now correctly shows the new definition location for pledgeCurrency in src/utils/interfaces.ts (line 1187).
31-31: Updated Property Reference for pledgeEndDate:
The "Defined in:" link on line 31 points to the updated location (line 1189) of the pledgeEndDate property.
47-47: Updated Property Reference for pledgeUsers:
The updated "Defined in:" link on line 47 now correctly points to the new location (line 1185) of the pledgeUsers property.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/SIGNIN_QUERY.md (1)
9-9: Documentation Link Updated: The updated line correctly reflects the new definition location for SIGNIN_QUERY (line 958 in src/GraphQl/Queries/Queries.ts). Please verify that the link is valid and consistently aligns with the recent GraphQL query updates.docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardPropsPG.md (2)
7-8: Update Reference: Corrected Source Location for Interface Definition.
The reference now points to line 15 in the source file, which reflects the recent reorganization in the code. This ensures that the documentation stays in sync with the actual code location.
17-18: Update Reference: Corrected Source Location for the Data Property.
The documentation now correctly indicates that the "data" property is defined at line 16 of the source file. This update improves clarity and helps developers quickly locate the property definition in the code.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/BLOCK_PAGE_MEMBER_LIST.md (1)
9-9: Ensure the Updated Definition Link is Correct.The reference has been updated to point to line 550 in the Queries.ts file. Please verify that this link correctly reflects the current definition of BLOCK_PAGE_MEMBER_LIST and remains accurate with any concurrent updates to the file.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md (4)
7-8: Updated Interface Location Reference
The reference now points to the new location at line 949 in src/utils/interfaces.ts, correctly reflecting the reorganization of the interface.
15-16: Updated ancestorTags Definition Link
The link for the ancestorTags property has been updated to line 952 as expected. This change aligns with the interface refactoring in the source file.
31-32: Updated childTags Definition Link
The childTags property now correctly points to its updated location at line 951 in the source file.
39-40: Updated Name Property Reference
The documentation for the name property is updated to reflect its new location at line 950, ensuring consistency with the restructured interface.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md (2)
7-7: Documentation Link Update for Interface DefinitionThe link now correctly points to the updated definition location in src/utils/interfaces.ts (line 972). This update is consistent with the overall interface reorganization.
15-15: Documentation Link Update for Advertisements PropertyThe link for the advertisements property now reflects the new source location (line 973) accurately. This change aligns with the new structure in the updated interfaces file.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md (4)
7-8: Verify the updated interface definition reference.
The link now points to [src/utils/interfaces.ts:958] as expected. Please ensure that the updated location is accurate and corresponds with the relocated definition in the source file.
15-16: Confirm the updated ancestorTags property reference.
The reference link has been updated to [src/utils/interfaces.ts:961]. Verify that this reflects the correct and current location of the ancestorTags property's definition.
31-32: Validate the updated name property reference.
The new link now points to [src/utils/interfaces.ts:959] for the interface’s name property. Please check that this update correctly maps to the updated source location.
39-40: Ensure the usersAssignedTo property reference is correct.
The updated reference now links to [src/utils/interfaces.ts:960]. Confirm that this link accurately reflects the new position of the usersAssignedTo property definition in the interface.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md (1)
9-9: Verify Updated Definition Link Reference.
The documentation now includes a clickable reference to the definition for ORGANIZATION_EVENT_CONNECTION_LIST. Please double-check that the referenced line number (729) in the URL matches the new location in src/GraphQl/Queries/Queries.ts as described in the PR objectives. The PR summary mentioned an update from line 622 to 710, so if line 710 is correct, consider updating the link accordingly.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionPg.md (4)
1-2: Link Clarity and Navigation
The "Admin Docs" link at the top serves as a navigational aid. Verify that it points to the intended landing page for admin documentation.
3-4: Use of Horizontal Rule
The horizontal divider ("***") effectively segments the document. Its usage is clear and consistent with typical markdown styling.
9-10: Section Title Verification
The "## Properties" section title correctly introduces the list of interface properties.
17-18: Formatting Consistency
The horizontal rule following the "edges" property section helps separate different documentation areas neatly.docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md (6)
7-7: Confirm Interface Declaration Reference Update
The reference for InterfacePostForm has been updated to point to line 868 in src/utils/interfaces.ts. This change is consistent with the restructuring and aligns with the new interface location.
15-15: Verify 'pinned' Property Location
The updated link now correctly points to the 'pinned' property's definition at line 873. This change accurately reflects the updated source, ensuring documentation consistency.
23-23: Verify 'postinfo' Property Location
The link for the 'postinfo' property now references line 870 in the source file, which aligns with the interface update. Everything appears accurate here.
31-31: Verify 'postphoto' Property Location
The documentation now correctly reflects that the 'postphoto' property is defined at line 871. This update maintains consistency with the codebase changes.
39-39: Verify 'posttitle' Property Location
The updated reference pointing to line 869 for the 'posttitle' property is now accurate. Please ensure that the ordering in the documentation matches the intended sequence in the source.
47-47: Verify 'postvideo' Property Location
The link for the 'postvideo' property now correctly references line 872 in the source file. This update is consistent with the modifications in src/utils/interfaces.ts.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST.md (1)
9-9: Verify Updated Definition ReferenceThe documentation now correctly points to the new definition location at line 823 in
src/GraphQl/Queries/Queries.ts. Please double-check that this link remains accurate over future changes to ensure the docs stay in sync with the actual source code.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFormData.md (6)
7-7: Correct Updated Interface Location Link
The updated link now correctly points to the new location of the InterfaceFormData definition in the source file (src/utils/interfaces.ts:1228). This improves accuracy in documentation.
15-15: Accurate Reference for Property "email"
The documentation now accurately reflects the source file by linking to src/utils/interfaces.ts:1231 for the email property. This clearly guides the reader to the correct implementation details.
23-23: Updated Reference for Property "firstName"
The documentation has been updated to show the new location (src/utils/interfaces.ts:1229) for the firstName property. This change is consistent with the refactoring in the source code.
31-31: Updated Reference for Property "gender"
The new link correctly points to src/utils/interfaces.ts:1233 for the gender property. The update ensures that the documentation remains in sync with the source changes.
39-39: Updated Reference for Property "lastName"
The change updates the link for the lastName property to src/utils/interfaces.ts:1230, aligning the documentation with the source file.
47-47: Updated Reference for Property "phoneNo"
The new link now correctly directs to src/utils/interfaces.ts:1232 for the phoneNo property. This ensures that the documentation accurately reflects the updated source code location.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionPg.md (3)
1-4: Review the Navigation Link and Introductory Block.
The file begins with a navigation link to the Admin Docs ([Admin Docs](/)) and a horizontal rule (***), which are clear and useful for navigation. Ensure that the homepage link accurately reflects the intended entry point for the documentation, and consider standardizing the horizontal rule style if it differs from other documentation pages.
5-8: Verify the Interface Header and Source Reference.
The header clearly identifies the interface (InterfaceOrganizationMembersConnectionPg) and provides a direct link to its source definition insrc/utils/interfaces.tsat line 697. Confirm that this source reference remains accurate over time, especially if the file or line numbers change during future refactoring.
17-24: Validate the 'pageInfo' Property Documentation.
ThepageInfoproperty is documented in a clear and straightforward manner with a link to theInterfacePageInfoPgdetails and its source reference. This consistency helps maintain a solid reference across documentation files. Ensure that both the Markdown link and source URL remain updated as the code evolves.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md (3)
7-7: Updated Interface Definition Reference
Line 7 now accurately points to the new definition location for the InterfaceQueryUserListItem in the source file (src/utils/interfaces.ts:1072). This update keeps the documentation in sync with the recent code reorganization.
15-15: Updated appUserProfile Definition Reference
Line 15 now reflects the correct location (src/utils/interfaces.ts:1111) for the appUserProfile property. This adjustment ensures users are directed to the latest definition in the codebase.
47-47: Updated user Property Definition Reference
Line 47 correctly updates the link to the new location for the user property definition (src/utils/interfaces.ts:1073). This enhances the maintainability of the documentation by aligning it with the updated source.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionEdgePg.md (4)
1-4: Header and Formatting VerificationThe header section with the "Admin Docs" link and the following separator (“***”) is clear and consistent with documentation practices.
5-8: Interface Title and Source ReferenceThe title "Interface: InterfaceOrganizationTagFoldersConnectionEdgePg" is clearly presented, and the link referencing the source location ([src/utils/interfaces.ts:746]) is both informative and accurate.
9-16: Property Documentation: CursorDocumenting the "cursor" property is well done. Specifying its type as
stringalong with a direct link to its definition ([src/utils/interfaces.ts:747]) allows for easy cross-referencing.
17-23: Property Documentation: NodeThe "node" property is clearly described with an inline link to
InterfaceTagFolderPg.mdand the corresponding source reference ([src/utils/interfaces.ts:748]). This ensures consistency and clarity in the documentation.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionPg.md (3)
1-4: Header and Formatting VerificationThe header section and use of markdown separators in this file are consistent with the documentation standards and improve readability.
5-8: Interface Title and Definition SourceThe title "Interface: InterfaceOrganizationTagFoldersConnectionPg" is well presented, and the link to its definition at [src/utils/interfaces.ts:741] is clear. This provides immediate contextual reference.
17-23: Property Documentation: PageInfoThe "pageInfo" property is clearly documented with a link to
InterfacePageInfoPg.mdand its source reference ([src/utils/interfaces.ts:743]). This section is coherent and aligns well with the overall documentation style.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_PG.md (3)
1-2: Link Initialization and Navigation
The opening link "Admin Docs" correctly provides a navigation point to the admin documentation. Please verify that the root path is accurate in the deployed environment to ensure smooth user navigation.
3-4: Effective Use of Horizontal Rule
The horizontal rule creates a clear visual separation in the document. This improves readability and is appropriate for the documentation layout.
9-10: Direct Source Reference Link
Providing a direct link to the source file at "src/GraphQl/Queries/Queries.ts:444" is very helpful for traceability and quick navigation. This adds significant value for developers looking to verify the implementation details.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md (10)
7-7: Link Update for Interface Location
The reference for the interface now indicates it is defined in src/utils/interfaces.ts:1027. Please verify that this updated link accurately reflects the new location of the interface definition.
15-15: Updated _id Property Reference
The link for the_idproperty now correctly points to src/utils/interfaces.ts:1028. Confirm that this change is consistent with the interface reorganization.
23-23: Updated createdAt Property Reference
The documentation now indicates thatcreatedAtis defined at src/utils/interfaces.ts:1034. This update appears correct according to the new source layout.
31-31: Updated creator Property Reference
The link for thecreatorproperty has been updated to src/utils/interfaces.ts:1036. Please double-check that this matches the current implementation in the source file.
51-51: Updated isArchived Property Reference
The reference now points to src/utils/interfaces.ts:1032 for theisArchivedproperty. This update looks aligned with the interface changes.
59-59: Updated isDefault Property Reference
The link for theisDefaultproperty has been updated to src/utils/interfaces.ts:1033. Confirm that this correctly reflects the new source position.
67-67: Updated name Property Reference
The documentation now shows that thenameproperty is defined at src/utils/interfaces.ts:1029. This change appears consistent with the source update.
75-75: Updated organizationId Property Reference
The reference for theorganizationIdproperty is updated to src/utils/interfaces.ts:1035. It’s advisable to verify that this is the correct location in the reorganized file.
83-83: Updated refrenceNumber Property Reference
The link forrefrenceNumbernow points to src/utils/interfaces.ts:1030. Ensure that this update matches the new documentation format.
91-91: Updated taxDeductible Property Reference
The documentation now showstaxDeductibleas defined at src/utils/interfaces.ts:1031. This appears to be a correct update in line with the interface modifications.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md (3)
7-7: Interface Definition Link Updated
The reference now correctly points to the new definition location in src/utils/interfaces.ts at line 967. Please verify that the link displays the intended section in the source file.
15-15: Property "name" Link Updated
The link for the "name" property has been updated to point to src/utils/interfaces.ts at line 968. This update appears correct; please confirm that it aligns with the interface reorganization.
23-23: Property "usersToAssignTo" Link Updated
The documentation now references the "usersToAssignTo" property at the new location (src/utils/interfaces.ts:969). This change is consistent with the recent modifications to the interface.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionPg.md (2)
1-2: Clear Navigation Link at the TopThe "Admin Docs" link is clear and concise, providing a straightforward way to return to the admin documentation homepage.
3-4: Horizontal Rule for Section SeparationThe use of "***" effectively separates the header from the rest of the document. This improves readability.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionEdgePg.md (3)
1-4: Header and Navigation Link FormatThe header section (lines 1–4) is clear and concise. The [Admin Docs] link is appropriately placed for navigation.
5-8: Interface Title and Source DefinitionThe interface title and the “Defined in” link (lines 5–8) correctly reference the source definition. The link to the source file (src/utils/interfaces.ts:681) is helpful for cross-referencing.
17-24: Documentation for the “node” PropertyThe “node” property (lines 17–24) is documented well by referencing the
InterfaceFundPginterface via a markdown link. The structure and link to the definition (src/utils/interfaces.ts:683) are clear.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionPg.md (3)
1-4: Header and Navigation Link FormatThe header section is consistent with other documentation files. The use of the [Admin Docs] link at the top is appropriate.
5-8: Interface Title and Source LinkThe interface title and the “Defined in” link (lines 5–8) clearly indicate where the interface is defined, linking back to the source file (src/utils/interfaces.ts:676).
17-24: Documentation for the "pageInfo" PropertyThe “pageInfo” property (lines 17–24) is well-documented with a clear reference to the
InterfacePageInfoPginterface. The formatting and link to its source definition (src/utils/interfaces.ts:678) are consistent with the rest of the document.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md (6)
7-7: Update Interface Definition ReferenceThe reference link now correctly points to the new location (src/utils/interfaces.ts:1062), ensuring that the documentation stays aligned with the relocated interface in the source.
15-15: Update _id Property ReferenceThe documentation now reflects the updated source reference for the
_idproperty (src/utils/interfaces.ts:1063), which improves traceability.
23-23: Update Email Property ReferenceThe link for the
31-31: Update firstName Property ReferenceThe reference for
firstNamenow correctly points to src/utils/interfaces.ts:1064, ensuring that users are directed to the precise location in the source file.
39-39: Update lastName Property ReferenceThe updated documentation now correctly links the
lastNameproperty to src/utils/interfaces.ts:1065, which maintains proper alignment with the source code.
47-47: Update organizationsBlockedBy ReferenceThe reference for
organizationsBlockedByhas been updated to src/utils/interfaces.ts:1067, ensuring that the documentation accurately reflects the source definition.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgInfoTypePG.md (7)
7-7: Documentation update for interface definition location.
The link now correctly points to the updated definition at line 437 in src/utils/interfaces.ts. Please verify that the source file reflects the intended interface structure.
15-15: Documentation update for property addressLine1.
The updated hyperlink now directs users to line 460 in src/utils/interfaces.ts. This change ensures consistency with the updated source code location for theaddressLine1property.
23-23: Documentation update for property avatarURL.
The link now points to line 439 in the source file. Ensure that the definition ofavatarURLin src/utils/interfaces.ts matches the documentation details provided here.
31-31: Documentation update for property description.
The updated URL now references line 459 in src/utils/interfaces.ts. This change correctly reflects the relocation of thedescriptionproperty in the codebase.
39-39: Documentation update for property id.
The hyperlink has been updated to point to line 438 in src/utils/interfaces.ts. Verify that this correlates with the current implementation of theidproperty.
47-47: Documentation update for property members.
The updated link directs to line 441 in src/utils/interfaces.ts, ensuring that the documentation is synchronized with the updated property definition formembers.
59-59: Documentation update for property name.
The link now correctly references line 440 in src/utils/interfaces.ts, which aligns with the current definition of thenameproperty.docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/interfaces/InterfaceUserSidebarOrgProps.md (5)
7-8: Interface Definition Reference Updated:
The "Defined in:" line now points to line 20 in the source file (UserSidebarOrg.tsx), which reflects the recent refactoring. Verify that this reference is consistent with all related documentation.
15-16: hideDrawer Property Reference Updated:
The documentation for thehideDrawerproperty has been updated to indicate its definition at line 23 in the source file. This update aligns well with the changes made to the component.
23-24: orgId Property Reference Updated:
TheorgIdproperty’s documentation now points to line 21 in the source file. Confirm that the ordering in the documentation matches the actual order inUserSidebarOrg.tsx.
31-32: setHideDrawer Property Reference Updated:
The link for thesetHideDrawerproperty now accurately reflects its definition at line 24 in the source file. This change maintains consistency in the documentation.
39-40: targets Property Reference Updated:
The reference for thetargetsproperty has been updated to line 22 in the source file. Ensure that this update correctly mirrors the current implementation order in the component.docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md (1)
9-9: Verify the Source Definition LinkThe link indicating the definition's location in [src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts:162] appears correct. Please ensure that this reference remains up to date if source file modifications occur and that it accurately reflects the current state of the type definition.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md (8)
7-7: Updated Interface Declaration LinkThe interface declaration link has been updated to point to [src/utils/interfaces.ts:1038]. This change correctly reflects the new location of the
InterfaceCampaignInfodeclaration in the source file.
15-15: Updated _id Property LinkThe documentation for the
_idproperty now links to [src/utils/interfaces.ts:1039], matching its new location in the interface file.
23-23: Updated createdAt Property LinkThe
createdAtproperty documentation now correctly reflects its updated definition location with the link pointing to [src/utils/interfaces.ts:1044].
31-31: Updated currency Property LinkThe
currencyproperty now points to [src/utils/interfaces.ts:1045] in the source code. This update ensures that the documentation remains consistent with the actual file structure.
39-39: Updated endDate Property LinkThe
endDateproperty link is updated to [src/utils/interfaces.ts:1043], reflecting the new location of its declaration. Please verify that this new link is accurate.
47-47: Updated fundingGoal Property LinkThe
fundingGoalproperty documentation now references [src/utils/interfaces.ts:1041], ensuring consistency with the relocated source definition.
55-55: Updated name Property LinkThe
nameproperty's link has been relocated to [src/utils/interfaces.ts:1040] as per the new source file structure. This update is correctly reflected in the documentation.
63-63: Updated startDate Property LinkThe
startDateproperty documentation now points to [src/utils/interfaces.ts:1042]. This ensures that the documentation is fully synchronized with the updated source file locations.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md (11)
7-7: Updated Interface Reference Link
The interface now shows its definition linked to [src/utils/interfaces.ts:341]. This update aligns with the recent reorganization in the source file and correctly directs readers to the new location.
20-20: Updated Definition for _id Property
The documentation now points to [src/utils/interfaces.ts:342] for the_idproperty. This change is consistent with the revised line numbering in the source file.
28-28: Updated Definition for allDay Property
The link for theallDayproperty has been updated to [src/utils/interfaces.ts:350]. This change correctly reflects the updated position of this property in the source file.
36-36: Updated Definition for description Property
Thedescriptionproperty now references [src/utils/interfaces.ts:344]. This update maintains consistency with the adjusted file structure.
44-44: Updated Definition for endDate Property
Documentation for theendDateproperty is now linked to [src/utils/interfaces.ts:346]. This accurately reflects its new location and ordering.
52-52: Updated Definition for endTime Property
TheendTimeproperty now shows a link to [src/utils/interfaces.ts:349]. The update is consistent with the recent changes to the source file’s structure.
60-60: Updated Definition for location Property
The documentation now points to [src/utils/interfaces.ts:347] as the source of thelocationproperty. This update appears to be correct and in line with the file's reorganization.
68-68: Updated Definition for recurring Property
The link for therecurringproperty has been updated to [src/utils/interfaces.ts:351]. This ensures the documentation reflects the updated source position accurately.
76-76: Updated Definition for startDate Property
The documentation now correctly links thestartDateproperty to [src/utils/interfaces.ts:345]. This change is consistent with the rest of the updated file.
84-84: Updated Definition for startTime Property
ThestartTimeproperty now points to [src/utils/interfaces.ts:348]. This update correctly corresponds to the new source structure.
92-92: Updated Definition for title Property
The documentation fortitlehas been updated with a new link to [src/utils/interfaces.ts:343]. This change is consistent with the revised interface order in the source file.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md (1)
1-10: Documentation Link Update for USER_ORGANIZATION_LIST
The documentation correctly reflects the new definition location of USER_ORGANIZATION_LIST as defined in src/GraphQl/Queries/Queries.ts:607. The formatting and link are clear and accurate.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_DATA_PG.md (1)
1-10: Accurate Documentation for GET_ORGANIZATION_DATA_PG
The new documentation entry for GET_ORGANIZATION_DATA_PG is succinct and correctly points to its definition at line 464 in the Queries.ts file. The markdown format and link provide clear guidance.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_PG.md (1)
1-10: Clear Documentation for GET_ORGANIZATION_EVENTS_PG
This file documents GET_ORGANIZATION_EVENTS_PG with a proper definition link to src/GraphQl/Queries/Queries.ts:417. The layout is consistent and the information is clear.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_MEMBERS_PG.md (1)
1-10: Documentation Entry for GET_ORGANIZATION_MEMBERS_PG Looks Good
The documentation for GET_ORGANIZATION_MEMBERS_PG is complete and correct, linking to its definition at line 397 in the Queries.ts file. The presentation is consistent with the other entries.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA.md (1)
1-10: Updated Documentation for GET_COMMUNITY_SESSION_TIMEOUT_DATA
The documentation now accurately reflects the updated definition location at src/GraphQl/Queries/Queries.ts:974. The change is clearly noted, and the file format remains clean and consistent.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_COUNT_PG.md (4)
1-2: Header Navigation Clarity
The link “Admin Docs” is a neat navigational aid that directs users back to the admin documentation homepage.
3-4: Section Separator Usage
The use of “***” as a separator provides a clear visual break between the header and subsequent content, enhancing readability.
5-6: Clear Title Declaration
The title “# Variable: GET_ORGANIZATION_POSTS_COUNT_PG” clearly communicates the subject of the document. This consistent formatting ensures that users immediately understand what variable is being documented.
9-9: Source Reference Accuracy
The “Defined in:” link correctly points to the source file and line number in the repository, providing developers with a quick way to locate the implementation. It’s advisable to periodically verify that the link remains valid as the project evolves.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryList.md (2)
7-7: Review the Definition Link Location.The link now indicates the interface is defined at line 362 in src/utils/interfaces.ts; however, the AI summary mentioned that the definition moved to line 391. Please verify that this documentation correctly reflects the new source location.
15-15: Confirm Property Name and Updated Link.The property is documented as "actionItemCategoriesByOrganization" with a link to line 363, yet the summary referred to a property "actionItemsByOrganization" with a new location at line 392. Ensure that the property name and its link are correct and consistent with the underlying changes in src/utils/interfaces.ts.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionEdgePg.md (4)
1-4: Header & Intro
The header section with the Admin Docs link and separator formatting is clear and consistent.
5-8: Interface Title & Definition Link
The interface title “InterfaceOrganizationVenuesConnectionEdgePg” is clearly stated and the “Defined in” link correctly points to the corresponding source code in src/utils/interfaces.ts.
9-17: Property “cursor” Documentation
Property “cursor” is well-documented. The type (string) is clearly specified and the link to its definition is provided.
19-23: Property “node” Documentation
The “node” property is documented clearly as being of type InterfaceVenuePg with an appropriate markdown link. The presentation is consistent with the rest of the file.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionPg.md (3)
1-4: Header & Intro
The header section repeats the standardized format with the Admin Docs link and separator; it sets a good tone for the rest of the document.
5-8: Interface Title & Definition Link
The title “InterfaceOrganizationVenuesConnectionPg” and the source code reference (linking to src/utils/interfaces.ts:781) are appropriately presented.
17-24: “pageInfo” Property Documentation
The documentation for the “pageInfo” property is clear, specifying it as type InterfacePageInfoPg with a link to its detailed documentation. No changes required here.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemInfo.md (13)
7-7: Updated Interface Reference: The reference to the interface definition is now updated to line 1236 in the source file. Please verify that this link accurately reflects the current location of the InterfaceAgendaItemInfo declaration.
15-15: Updated _id Property Reference: The documentation for the _id property now points to line 1237. This update is correct provided that the new line number matches the updated codebase.
23-23: Updated Attachments Property Reference: The reference for the attachments property has been updated to line 1241 in the source file. Ensure that this link properly corresponds to the current definition.
31-31: Updated Categories Property Reference: The link in the categories property section now directs to line 1254. This change appears consistent with the reorganization.
47-47: Updated CreatedBy Property Reference: The updated link for the createdBy property now points to line 1242. Please confirm that this reflects the correct location of the property definition.
67-67: Updated Description Property Reference: The documentation for the description property now references line 1239. Verify that this update aligns with the current structure in src/utils/interfaces.ts.
75-75: Updated Duration Property Reference: The duration property reference has been updated to line 1240. This change seems correct given the reorganization; please double-check for consistency.
83-83: Updated Organization Property Reference: The organization property now cites line 1258 in the source file. Confirm that this update accurately reflects the current implementation.
99-99: Updated RelatedEvent Property Reference: The relatedEvent property is now linked to line 1262. Please verify that the source file’s structure has been updated accordingly.
115-115: Updated Sequence Property Reference: The sequence property reference now points to line 1253. This update appears to be accurate; ensure that all consumers of this documentation are aware of the change.
123-123: Updated Title Property Reference: The title property now references line 1238. Verify that this change is intentional and aligns with the updated file structure.
131-131: Updated URLs Property Reference: The documentation for the urls property has been updated to line 1247. Please confirm that the new reference is correct and consistent with the source file.
139-139: Updated Users Property Reference: The link for the users property now points to line 1248. This change maintains consistency with the latest code reorganization.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md (6)
7-7: Verified Interface Definition ReferenceThe link for the interface definition now correctly points to src/utils/interfaces.ts:354. This accurately reflects the updated location in the source file.
15-15: Verified _id Property LocationThe link for the _id property now points to src/utils/interfaces.ts:355. This update is consistent with the new property placement.
23-23: Verified createdAt Property LocationThe reference for the createdAt property has been updated correctly to src/utils/interfaces.ts:358. No issues detected.
31-31: Verified creator Property LocationThe creator property now correctly points to src/utils/interfaces.ts:359, accurately reflecting the updated documentation.
51-51: Verified isDisabled Property LocationThe link for the isDisabled property has been updated to src/utils/interfaces.ts:357. This clearly maps to the new location.
59-59: Verified name Property LocationThe reference for the name property is now correctly set to src/utils/interfaces.ts:356, in accordance with the updated interface structure.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionPg.md (6)
1-2: Navigation Link CheckThe "Admin Docs" link at the top is clear and correctly points to the homepage.
3-4: Horizontal Rule PresentationThe use of the horizontal rule (represented by "***") effectively separates the header/navigation from the main content.
5-8: Interface Header and Source ReferenceThe interface title and the link to its definition in "src/utils/interfaces.ts" are well documented. This provides readers with a quick way to locate the source code.
9-10: Properties Section HeaderThe "## Properties" header clearly defines the section where the interface's properties are detailed.
17-18: Section Separator for ReadabilityThe second horizontal rule is effectively used to separate the properties sections, enhancing readability.
19-24: PageInfo Property DocumentationThe documentation for the "pageInfo" property is concise and includes a direct link to its source definition, which makes it easy for users to find more details.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md (5)
7-7: Verify Updated Interface Definition Reference.
Ensure that the link "Defined in: src/utils/interfaces.ts:1207" accurately reflects the new location of the interface declaration in your reorganized codebase.
15-15: Confirm Property _id Reference.
The reference for the_idproperty now points to src/utils/interfaces.ts:1208. Please double-check that this line number correctly represents the current location in the source file after reorganization.
23-23: Check Property Naming Consistency for Creator.
The documentation now shows the property as createdBy with a link to src/utils/interfaces.ts:1211. Note that the AI summary mentioned a property named "creator" while this doc references "createdBy". Please verify that this change in nomenclature is intentional and consistently updated throughout the codebase.
43-43: Confirm Description Property Link.
The reference for the description property is now updated to src/utils/interfaces.ts:1210. This appears accurate—please ensure it reflects the actual source location.
51-51: Verify Name Property Reference.
The link for the name property now points to src/utils/interfaces.ts:1209. Confirm that this reference correctly matches the current source structure.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md (9)
7-7: Interface Definition Reference Update
The documentation now points to the interface definition in the source file at line 850. Please verify that this link accurately corresponds to the intended section in src/utils/interfaces.ts.
15-15: Property _id Reference Update
The _id property's definition link was updated to point to line 851 of the source file. Confirm that this update correctly reflects the current location of the _id property's declaration.
23-23: Property address Reference Update
The address property now references its definition at line 865 in the source file. Ensure that this revised link points to the correct location for the address property in the updated interface.
31-31: Property admins Reference Update
The admins property’s documentation has been updated to link to line 861. Please double-check that this link is accurate and points to the updated declaration of the admins property.
43-43: Property createdAt Reference Update
The link for the createdAt property now points to line 864 in the source file. Verify that this reference aligns with the new organization of properties in the interface file.
51-51: Property creator Reference Update
The creator property's reference has been updated to line 853. Please ensure that this updated link correctly reflects the location of the creator property in the source file.
67-67: Property image Reference Update
The image property now correctly links to its definition at line 852. Confirm that this change accurately reflects the updated interface structure.
75-75: Property members Reference Update
The members property has been updated with a link pointing to line 858 in the source file. Please review that this reference is correct and corresponds to the recent changes in the source interface.
87-87: Property name Reference Update
The documentation for the name property now points to line 857 in the source file. Ensure that this link is accurate and reflects the current location of the name property in the interface.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md (8)
7-7: Interface Definition Location Updated.
The link now correctly points to the updated definition location in src/utils/interfaces.ts (line 402). Verify that this link remains accurate after future changes.
15-15: _id Property Reference Updated.
The reference for the _id property now points to line 403, which aligns with the updated source file.
23-23: createdAt Property Reference Updated.
The updated link for createdAt now correctly points to line 408 in the source file. This ensures consistency with the new interface structure.
31-31: email Property Reference Updated.
The email property reference link now correctly directs to line 406 in src/utils/interfaces.ts.
39-39: firstName Property Reference Updated.
The reference for firstName has been modified to point to line 404. This update is in line with the new sourcing information.
47-47: image Property Reference Updated.
The link for the image property now points to line 407, reflecting the updated position in the source file.
55-55: lastName Property Reference Updated.
The lastName property link now correctly points to line 405. The update appears consistent with the overall changes.
63-63: organizationsBlockedBy Property Reference Updated.
The reference for organizationsBlockedBy now correctly points to line 409, which finalizes the update for all property links.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatMessagePg.md (7)
5-8: Interface Definition Section:
The interface title "InterfaceChatMessagePg" is clearly stated along with a direct link to its source location in the codebase. This creates a good traceability between the documentation and the source code.
9-16: Property 'body' Documentation:
The documentation for the "body" property is concise, correctly indicating the typestring, and provides a direct reference to its definition line in the source file.
17-24: Property 'chat' Documentation:
The "chat" property documentation correctly includes a type link toInterfaceChatPgand specifies its source location. Please verify that the linked "InterfaceChatPg.md" file exists and provides sufficient context. Optionally, consider adding a brief descriptive note about what the chat property represents.
27-32: Property 'createdAt' Documentation:
The "createdAt" property is well-documented with the correct type (string) and a precise source reference. The clarity in documentation is commendable.
35-40: Property 'creator' Documentation:
The "creator" property is documented effectively; linking it to theInterfaceUserPghelps maintain consistency and traceability between related interfaces.
43-48: Property 'id' Documentation:
The "id" property is straightforwardly documented, with its type correctly designated asIDand a precise source reference.
59-64: Property 'updatedAt' Documentation:
The "updatedAt" property's documentation is clear and complete, indicating its type (string) and providing an accurate source reference.docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md (8)
7-7: Updated Interface Definition ReferenceThe documentation now correctly points to the new location of the InterfacePledgeInfo definition in the source (
src/utils/interfaces.ts:1047). This update aligns the docs with the revised code structure.
15-15: Updated _id Property ReferenceThe
_idproperty reference has been updated to point to its new location (src/utils/interfaces.ts:1048). This change ensures that readers and tools can accurately locate the definition.
23-23: Updated amount Property ReferenceThe
amountproperty documentation now reflects its new source location (src/utils/interfaces.ts:1050). This keeps the documentation in sync with the codebase.
31-31: Updated Campaign Property ReferenceThe reference for the optional
campaignproperty now correctly points tosrc/utils/interfaces.ts:1049. Please double-check that this link accurately reflects the new code organization.
51-51: Updated currency Property ReferenceThe documentation for the
currencyproperty has been updated to reference its new definition location (src/utils/interfaces.ts:1051). This update maintains consistency across the documentation.
59-59: Updated endDate Property ReferenceThe reference for the standalone
endDateproperty is now updated tosrc/utils/interfaces.ts:1052. This change correctly aligns with the updated code relocation.
67-67: Updated startDate Property ReferenceThe documentation now correctly points to the new location for the
startDateproperty (src/utils/interfaces.ts:1053). This helps in maintaining clear traceability.
75-75: Updated users Property ReferenceThe
usersproperty documentation has been updated with the new reference (src/utils/interfaces.ts:1054). This ensures that the interface documentation remains accurate and up-to-date.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatPg.md (11)
1-8: File Header and Interface Reference:
The header clearly provides a navigation link ("Admin Docs") and an informative title for the interface, along with a direct link to its source definition. This sets a good context for the documentation reader.
11-17: Documentation for 'avatarMimeType':
The section for the "avatarMimeType" property is concise and informative. It clearly indicates that the property is of typestringand includes a precise reference link to the source definition.
19-24: Documentation for 'avatarURL':
The "avatarURL" documentation is similarly clear, properly stating the property type asstringand providing the corresponding source reference. Consistency is maintained with the previous property section.
27-32: Documentation for 'createdAt':
The "createdAt" property is well-documented with its type clearly specified and a direct link to its source location. This straightforward presentation aids developer understanding.
35-40: Documentation for 'creator':
The "creator" property leverages a link toInterfaceUserPg.mdand includes a reference to its definition in the source file. This cross-referencing is very helpful for navigating related types.
43-48: Documentation for 'description':
The "description" property is documented efficiently, showing its type (string) along with a source reference. The clarity and consistency with other properties are maintained.
51-56: Documentation for 'id':
Listing the "id" property as of typeID, this section follows the established format and provides an easy-to-follow source link.
59-64: Documentation for 'name':
The "name" property is documented with a clear type declaration (string) and an appropriate reference to its source definition, mirroring the style of previous sections.
67-72: Documentation for 'organization':
The "organization" property employs a link toInterfaceOrganizationPg.mdto indicate its type. This consistent pattern of cross-referencing related interfaces is very beneficial for maintainability.
75-80: Documentation for 'updatedAt':
The "updatedAt" section clearly specifies its type (string) and includes a direct reference to its source location, keeping the documentation uniform and easily navigable.
83-88: Documentation for 'updater':
The final property, "updater", is documented in a similar manner using a link toInterfaceUserPg.mdand a clear declaration of its type. This ensures consistency across the interface documentation.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md (1)
9-9: Documentation update verified.The revised link correctly points to the updated definition at line 785 in src/GraphQl/Queries/Queries.ts. This change aligns with the updated query definitions and overall restructuring outlined in the PR.
Consider verifying periodically that subsequent refactoring doesn't alter the referenced line, which might necessitate updating this link again.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md (4)
7-7: Documentation Reference Update: Interface Location Reassigned
The reference link for the InterfaceCreateFund now accurately points to the new location at src/utils/interfaces.ts:1139. This update improves traceability to the source code.
15-15: Documentation Update: 'fundName' Property Reference
The updated link for the fundName property is correct and now directs users to src/utils/interfaces.ts:1140.
23-23: Documentation Update: 'fundRef' Property Reference
The documentation for fundRef has been updated correctly to point to src/utils/interfaces.ts:1141, ensuring consistency with the new interface structure.
47-47: Documentation Update: 'taxDeductible' Property Reference
The documentation for taxDeductible has been updated appropriately to reflect its new location at src/utils/interfaces.ts:1144.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventAttachmentPg.md (7)
1-2: Navigation Link is Clear.
The “Admin Docs” link is clear and provides a quick way for users to navigate back to the admin documentation homepage.
3-4: Consistent Section Separator.
The use of a horizontal rule (***), as seen on these lines, effectively separates content sections and maintains a clean documentation layout.
5-7: Clear Interface Heading and Source Reference.
The header “# Interface: InterfaceEventAttachmentPg” is explicit, and the “Defined in:” link provides direct traceability to the source definition in the code. This is particularly useful for maintainability and quick navigation within the repository.
9-10: Well-Structured Properties Section.
The “## Properties” heading clearly introduces the subsequent details. This straightforward labeling supports ease of reading and navigation within the documentation.
11-16: Thorough ‘mimeType’ Property Documentation.
The documentation for the “mimeType” property is concise and well-formatted: it specifies the expected type (string) and provides a direct URL reference to its definition location (src/utils/interfaces.ts:672). This structured approach benefits users needing to trace back to the implementation details.
17-17: Effective Section Demarcation.
The horizontal rule at this point is an effective tool to visually separate distinct sections of the documentation, enhancing overall readability.
19-23: Clear ‘url’ Property Documentation.
The “url” property is documented in a similar, clear manner: it specifies the type (string) and includes a reference link to its definition (src/utils/interfaces.ts:673). This consistent documentation style across properties supports both readability and maintainability.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md (7)
7-7: Reference Update: Interface Definition Location.
The updated reference now correctly points tosrc/utils/interfaces.tsat line 1016 whereInterfaceQueryFundCampaignsPledgesis defined. Please verify that this location matches the current structure in the source.
15-15: Reference Update: Currency Property.
The documentation now links to the updated position at line 1022 in the source file for thecurrencyproperty. This ensures consistency between the docs and code.
23-23: Reference Update: EndDate Property.
TheendDateproperty now references line 1024. This change appears correct given the updated organization of the interfaces.
31-31: Reference Update: FundId Property.
The updated linkage now points to line 1017 for thefundIdproperty definition. Ensure that this reflects the latest source changes.
43-43: Reference Update: FundingGoal Property.
ThefundingGoalproperty now correctly documents its definition at line 1021, aligning with the restructured source.
59-59: Reference Update: Pledges Property.
The reference now correctly points to line 1025 for thepledgesproperty. Verify that this change consistently reflects the updated codebase.
67-67: Reference Update: StartDate Property.
The updated documentation now references line 1023 forstartDate, which is in line with the recent code reordering.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundPg.md (11)
1-4: Doc Header and Navigation
The header line "Admin Docs" provides a clear and concise navigation link. The formatting is clean and appropriate for the documentation home.
5-8: Interface Title and Source Definition
The title "Interface: InterfaceFundPg" is prominently displayed, and the provided "Defined in:" link correctly points to the source code location. Please ensure this reference is updated if the source file changes.
9-16: CreatedAt Property Documentation
The "createdAt" property is clearly documented with its type (string) and a direct link to where it is defined in the source code. This is concise and follows the project's documentation standards.
17-24: Creator Property Documentation
The entry for "creator" is well presented, using a markdown link toInterfaceUserPg. This cross-reference aids developer navigation. Verify that the linked file exists and remains up-to-date.
25-32: ID Property Documentation
The "id" property is documented as typeIDwith an accompanying definition link. Everything is clear and consistent with the other property documentations.
33-40: isTaxDeductible Property Documentation
The documentation for "isTaxDeductible" clearly specifies itsbooleantype and offers a link to the definition. The presentation is uniform with the rest of the interface properties.
41-48: Name Property Documentation
The "name" property is defined as astring, and the documentation includes a direct link to the source reference. Consistent markdown formatting is maintained here.
49-56: Organization Property Documentation
The "organization" property is documented with a link toInterfaceOrganizationPg. Ensure that the referenced documentation is accessible and correctly located relative to this file.
57-64: UpdatedAt Property Documentation
The "updatedAt" property is succinctly documented as astring, with the link reaffirming its defined location. This segment follows the overall consistency well.
65-71: Updater Property Documentation
The "updater" property, referencingInterfaceUserPg, is clearly documented with relevant details. The consistent use of markdown and links enhances clarity.
1-71: Overall Documentation Quality
This new markdown file provides comprehensive and well-organized documentation for theInterfaceFundPginterface. All properties are clearly defined with their types and corresponding source links, ensuring ease of navigation and maintainability.docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePaginationArgs.md (5)
1-4: Document Header and Navigation LinkThe header provides a clear navigation link to the Admin Docs and uses a horizontal rule for visual separation, which is helpful for navigating the documentation.
5-8: Interface Title and Source ReferenceThe title "Interface: InterfacePaginationArgs" is clear and immediately informs the reader about the documented interface. The "Defined in" link to the source file is very useful for quick reference.
9-10: Properties Section HeaderThe "## Properties" header neatly introduces the section where individual properties of the interface are documented.
25-32: "first" Property DocumentationThe "first" property is documented with a clear type (
number) and a direct reference to its source definition. Its presentation is consistent with the other properties.
33-40: "last" Property DocumentationThe "last" property follows the same structured format as the others, providing clarity and consistency in documentation. No adjustments required.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md (13)
7-7: Updated Interface Definition Link
The link now correctly points to the new definition location at line 1147 in src/utils/interfaces.ts. Verify that this location remains the intended central definition.
15-15: Updated commentCount Link
The documentation for the commentCount property now references src/utils/interfaces.ts:1161. This change correctly reflects the new organization of the source code.
23-23: Updated comments Array Link
The link for the comments property is updated to point to line 1162 in the source. This update appears consistent with the rest of the documentation changes.
67-67: Updated Creator Definition Link in Creator Section
The link now points to src/utils/interfaces.ts:1149, clearly identifying the creator’s type definition. This helps maintain clarity in the documentation structure.
91-91: Updated fetchPosts() Link
The fetchPosts method now links to its new definition location at line 1181 in src/utils/interfaces.ts. This update ensures that users can directly navigate to the correct implementation.
103-103: Updated id Property Link (First Occurrence)
The id property is now documented with a link to src/utils/interfaces.ts:1148. The updated reference improves traceability of the code changes.
111-111: Updated image Property Link
The updated link for the image property now points to line 1156 in src/utils/interfaces.ts, aligning the documentation with the current implementation.
119-119: Updated likeCount Property Link
The link for the likeCount property has been updated to reference src/utils/interfaces.ts:1160. This change ensures consistency with the new source code layout.
127-127: Updated likedBy Property Link
The likedBy property’s definition is now correctly referenced from src/utils/interfaces.ts:1176. The documentation accurately now reflects the updated file structure.
147-147: Updated postedAt Property Link
The postedAt property now points to its new defined location at line 1155 in src/utils/interfaces.ts, ensuring readers are directed to the correct part of the source.
155-155: Updated text Property Link
The text property is now documented with a link to line 1158 in the source file. This update keeps the documentation in sync with code changes.
163-163: Updated title Property Link
The title property link now refers to src/utils/interfaces.ts:1159. This precise reference improves clarity for developers navigating the interface definitions.
171-171: Updated video Property Link
The video property now correctly links to line 1157 in the source, ensuring that the documentation remains accurate after the recent refactoring.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md (3)
7-7: Correct Interface Reference UpdateThe link now points to src/utils/interfaces.ts:1222 which correctly reflects the new location of the interface definition.
15-15: Accurate Method Location for handleClose()The updated reference for the handleClose() method correctly points to line 1224 in the source file, ensuring documentation accuracy.
27-27: Verified reloadMembers() ReferenceThe documentation now accurately links the reloadMembers() method definition to src/utils/interfaces.ts:1225.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md (7)
7-7: Link Update for Interface Definition
The reference now points to src/utils/interfaces.ts:1281 for the interface definition. Please confirm that this location is correct and reflects the actual definition in the source.
15-15: Link Update for Property _id
The documentation for the_idproperty has been updated to reference src/utils/interfaces.ts:1282. Ensure that this link accurately represents the new declaration location.
23-23: Link Update for Assignments Property
The pointer for theassignmentsproperty now points to src/utils/interfaces.ts:1286. Verify that this reference correctly reflects the updated source.
35-35: Link Update for Groups Property
The documentation for thegroupsproperty has been updated with a reference to src/utils/interfaces.ts:1289. Please check that this change accurately reflects the new location of the property definition.
55-55: Link Update for hasAccepted Property
ThehasAcceptedproperty now references src/utils/interfaces.ts:1283. Ensure that this update is consistent with the source code’s new structure.
63-63: Link Update for hoursVolunteered Property
The documentation forhoursVolunteeredhas been updated to point to src/utils/interfaces.ts:1284. Please confirm that this link is correct and the referenced code is properly documented.
71-71: Link Update for user Property
The reference for theuserproperty now links to src/utils/interfaces.ts:1285. Verify that this update correctly reflects the relocation of the property definition.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemInfo.md (17)
7-7: Update interface definition reference.
The "Defined in:" link has been updated to reflect the new declaration location at line 366 in src/utils/interfaces.ts. Please verify that the URL correctly points to the intended definition.
15-15: Update _id property reference.
The documentation now correctly points to line 367 in src/utils/interfaces.ts for the _id property. Confirm that this matches the updated interface structure.
23-23: Update actionItemCategory reference.
The "Defined in:" link for actionItemCategory has been updated to reflect its new line (373) in src/utils/interfaces.ts. This update appears accurate with the broader interface reorganization.
39-39: Update allottedHours reference.
The documentation now points to line 388 in src/utils/interfaces.ts for allottedHours. Verify that this line number correctly represents the property's definition after recent changes.
47-47: Update assignee property reference.
The link for the assignee property has been updated to line 369 in src/utils/interfaces.ts. This ensures the documentation reflects the new source location.
55-55: Update assigneeGroup reference.
The reference for assigneeGroup now directs to line 370 in src/utils/interfaces.ts. Please check that this updated mapping is consistent with the interface changes.
63-63: Update assigneeType reference.
The link for assigneeType has been refreshed to point to line 368 in src/utils/interfaces.ts. Confirm that this correctly represents the property’s new location.
71-71: Update assigneeUser reference.
The documentation for assigneeUser now correctly references line 371 in src/utils/interfaces.ts. This change is consistent with the overall updates to the interface.
79-79: Update assigner property reference.
The link has been modified to indicate that assigner is now defined at line 372 in src/utils/interfaces.ts. Ensure that this update is properly mirrored in any related documentation.
87-87: Update assignmentDate reference.
The "Defined in:" link for assignmentDate has been updated to line 379 in src/utils/interfaces.ts. This new reference should be verified against the updated source file.
95-95: Update completionDate reference.
The documentation now shows completionDate being defined at line 381 in src/utils/interfaces.ts. Please verify the correctness of this new line reference.
103-103: Update creator reference.
The link for the creator property has been updated to line 387 in src/utils/interfaces.ts. This change appears consistent with the interface reorganization.
111-111: Update dueDate reference.
The "Defined in:" URL for dueDate now points to line 380 in src/utils/interfaces.ts. Ensure that the updated reference accurately reflects the property’s definition.
119-119: Update event reference.
The documentation for the event property has been updated to indicate a definition at line 383 in src/utils/interfaces.ts. Confirm that this URL accurately maps to the new location.
135-135: Update isCompleted reference.
The "Defined in:" line for isCompleted now directs to line 382 in src/utils/interfaces.ts. Please verify that this update correctly reflects the property’s current definition.
143-143: Update postCompletionNotes reference.
The documentation now shows postCompletionNotes defined at line 378 in src/utils/interfaces.ts. Verify that the updated link aligns with the interface changes.
151-151: Update preCompletionNotes reference.
The "Defined in:" link for preCompletionNotes has been updated to line 377 in src/utils/interfaces.ts. This update appears consistent; please confirm its accuracy.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md (13)
7-7: Updated Interface Definition Reference
The "Defined in" link now correctly points to [src/utils/interfaces.ts:1056] to reflect the interface’s new location following the reorganization.
19-19: Updated _id Property Reference
The reference for the _id property has been updated to [src/utils/interfaces.ts:342], which aligns with its new definition in the source file.
31-31: Updated allDay Property Reference
The documentation now accurately reflects that the allDay property is defined at [src/utils/interfaces.ts:350].
43-43: Updated description Property Reference
The "Defined in" link for description correctly points to [src/utils/interfaces.ts:344], confirming the recent update in the source file.
55-55: Updated endDate Property Reference
The endDate property now shows its updated definition at [src/utils/interfaces.ts:346] as part of the interface reorganization.
67-67: Updated endTime Property Reference
The reference for endTime has been updated to [src/utils/interfaces.ts:349], which is consistent with the recent changes.
79-79: Updated isPublic Property Reference
The isPublic property now points to its new location at [src/utils/interfaces.ts:1058]. Please verify that this aligns with the intended refactoring.
87-87: Updated isRegisterable Property Reference
isRegisterable now points to [src/utils/interfaces.ts:1059] as expected; the update is in line with the interface restructuring.
95-95: Updated location Property Reference
The documentation for the location property has been updated to link to [src/utils/interfaces.ts:347], ensuring consistency with the codebase.
107-107: Updated recurring Property Reference
The recurring property now correctly references [src/utils/interfaces.ts:351], reflecting its new definition location.
119-119: Updated startDate Property Reference
The startDate property documentation now points to [src/utils/interfaces.ts:345] in accordance with the updated interface.
131-131: Updated startTime Property Reference
The "Defined in" link for startTime has been updated to [src/utils/interfaces.ts:348]. This update is consistent with the overall interface changes.
143-143: Updated title Property Reference
The title property reference now correctly points to [src/utils/interfaces.ts:343], reflecting its new position after the code reorganization.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md (13)
7-7: Link Verification for Interface Definition
The reference on line 7 now points to src/utils/interfaces.ts:470. Please double-check that this link accurately reflects the new location of the interface definition in the reorganized source file.
15-15: Link Verification for _id Property
The updated link on line 15 directs to src/utils/interfaces.ts:471. Confirm that this location correctly corresponds to the current definition of the _id property in the source file.
23-23: Link Verification for address Property
Line 23 now shows a link to src/utils/interfaces.ts:480. Please verify that the address property is indeed defined at this new location and that the reference remains accurate.
31-31: Link Verification for admins Property
The admins property link on line 31 is updated to src/utils/interfaces.ts:489. Ensure that this reflects the correct and current source location for the admins definition.
59-59: Link Verification for blockedUsers Property
On line 59, the blockedUsers property is now linked to src/utils/interfaces.ts:504. Verify that the updated reference accurately points to the current definition within the source file.
83-83: Link Verification for creator Property
The creator property reference on line 83 has been updated to src/utils/interfaces.ts:473. Please check that this link is both correct and consistent with the source code changes.
103-103: Link Verification for description Property
Line 103 now points to src/utils/interfaces.ts:479 for the description property. Confirm that this update correctly reflects the definition's new location in the source file.
111-111: Link Verification for image Property
The image property link on line 111 has been updated to src/utils/interfaces.ts:472. Ensure that this reference is accurate and corresponds with the updated source structure.
119-119: Link Verification for members Property
On line 119, the reference for the members property is now set to src/utils/interfaces.ts:483. Please verify that this link correctly reflects the members property’s current definition.
143-143: Link Verification for membershipRequests Property
The membershipRequests property on line 143 has an updated link to src/utils/interfaces.ts:496. Confirm that this reference accurately points to the new location of the membershipRequests definition.
171-171: Link Verification for name Property
Line 171 now shows a link for the name property pointing to src/utils/interfaces.ts:478. Please ensure that this update accurately reflects the new source location for the name property.
179-179: Link Verification for userRegistrationRequired Property
The updated link on line 179 now directs to src/utils/interfaces.ts:481. Verify that this reference is correct according to the new interface arrangement.
187-187: Link Verification for visibleInSearch Property
Line 187 now updates the visibleInSearch property link to src/utils/interfaces.ts:482. Please check that this reference aligns with the revised definition in the source file.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md (9)
7-7: Interface Definition Link Updated
The documentation now points to the interface’s updated location at [src/utils/interfaces.ts:414]. Please verify that this reference is accurate and consistent with the refactored source code.
15-15: _id Property Link Updated
The_idproperty link has been updated to [src/utils/interfaces.ts:415]. Ensure that this new reference correctly reflects the position in the updated interface file.
[approve]
23-23: Address Property Link Updated
The link for theaddressproperty now references [src/utils/interfaces.ts:430]. Please confirm that this change accurately matches the new code location.
[approve]
31-31: Admins Property Link Updated
The documentation for theadminsproperty is now linked to [src/utils/interfaces.ts:426]. Verify that this updated link correctly corresponds to the source file’s new structure.
[approve]
43-43: CreatedAt Property Link Updated
The reference for thecreatedAtproperty has been updated to [src/utils/interfaces.ts:429]. Please double-check that this figure accurately reflects the relocation in the source.
[approve]
51-51: Creator Property Link Updated
The documentation now shows thecreatorproperty defined at [src/utils/interfaces.ts:417]. Ensure that this link is correct per the updated interface file.
[approve]
71-71: Image Property Link Updated
Theimageproperty link has been updated to [src/utils/interfaces.ts:416]. Please verify that this reference correctly represents its new location in the code.
[approve]
79-79: Members Property Link Updated
The updated reference for themembersproperty now points to [src/utils/interfaces.ts:423]. Confirm that this link is in line with the changes in the source file.
[approve]
91-91: Name Property Link Updated
The documentation for thenameproperty now directs to [src/utils/interfaces.ts:422]. Please check that this updated link is accurate and reflects the current code structure.
[approve]docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionEdgePg.md (3)
1-8: Overall Header and Context are ClearThe header section introduces the documentation cleanly with a navigation link and a clear title. The "Defined in" link accurately points to the source definition location.
9-16: Property "cursor" Documentation is Well-StructuredThe "cursor" property is documented with a concise type declaration (
string) and a precise reference to its definition. The clarity of this information should greatly help developers navigating the code.
17-23: Property "node" Documentation is Clear and NavigableThe "node" property is neatly documented, with a markdown link to the
InterfaceTagPgdocumentation. This clear linkage enhances traceability and comprehension.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionPg.md (2)
1-8: Overall Header and Interface Identification are AccurateThe header section provides a clear title and an accurate reference to the source location for
InterfaceOrganizationTagsConnectionPg. The formatting is consistent with other documentation files.
17-24: Property "pageInfo" is Documented EffectivelyThe "pageInfo" property section is clear, listing its type along with a direct link to the corresponding documentation. This consistency aids developers in understanding its context within the interface.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePageInfoPg.md (5)
1-8: Overall File Header is Concise and InformativeThe header clearly identifies the interface and provides a direct GitHub link to where the interface is defined. This consistency simplifies cross-referencing and maintenance.
11-16: Property "endCursor" is Clearly DocumentedThe "endCursor" section specifies the type (
string) and provides a direct reference to its definition. This straightforward documentation is helpful and aligns with our documentation standards.
19-24: Property "hasNextPage" is Accurately DocumentedThe "hasNextPage" property section is concise, accurately indicating its boolean type and linking to the source definition. This meets the clarity and traceability requirements.
27-32: Property "hasPreviousPage" Documentation is ConsistentThe "hasPreviousPage" property is documented similarly to other properties, maintaining a coherent style and clear reference to its source location.
35-39: Property "startCursor" is Documented SufficientlyThe "startCursor" section follows the established documentation pattern, indicating its type and definition source. The consistent structure across properties is commendable.
docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md (1)
9-9: Documentation Link Validation: Confirm Accurate ReferenceThe provided reference link to the source file is a good practice for traceability. Please verify that the file path remains accurate as the repository evolves. Keeping this link up-to-date will ensure that users can easily navigate to the related source code.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionEdgePg.md (4)
1-4: Clean Introductory SectionThe opening lines, including the "Admin Docs" link and the separator markers, effectively set the context for the documentation. The formatting is clear and concise.
5-8: Clear Interface HeaderThe header clearly identifies the interface name and provides an accurate link to its source file location in the repository. This greatly aids in traceability across documentation and source code.
9-17: Well-Documented Property: cursorThe documentation for the "cursor" property is concise and includes a direct reference to its definition in the source file. The markdown styling is consistent and clear.
19-23: Effective Documentation for Property: nodeThe documentation for the "node" property not only specifies its type but also correctly links to the
InterfaceEventPgdocumentation, facilitating easy navigation among related types.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionPg.md (4)
1-4: Clean Introductory SectionThe introductory section with the "Admin Docs" link and horizontal separator is well-structured and sets a clear context for the content that follows.
5-8: Clear Interface IdentificationThe interface header accurately specifies
InterfaceOrganizationEventsConnectionPgand includes a link pointing directly to its definition in the source file. This improves documentation transparency.
9-17: Properly Documented Property: edgesThe "edges" property is documented using consistent markdown formatting. The link to
InterfaceOrganizationEventsConnectionEdgePg.mdis appropriately noted with the array notation ([]), making it explicit that this property is an array type.
19-23: Well-Documented Property: pageInfoThe "pageInfo" property is clearly defined with an accurate link to its corresponding documentation. The consistency in styling with other properties enhances overall readability.
docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventPg.md (5)
1-4: Clean Introductory SectionThe file starts with a simple, clear introductory header and navigation link, setting up a good context for the detailed interface documentation that follows.
5-8: Clear Interface DefinitionThe header correctly presents the
InterfaceEventPginterface and provides a direct link to its source definition. This linkage is useful for quick reference and cross-verification.
11-16: Documentation for Property "event"The "event" property is documented with a simple type declaration as
object, along with a clear reference to its definition in the source file. This straightforward approach aids in clarity.
17-20: Clear Documentation for Property "attachments"The "attachments" property is documented as an array of
InterfaceEventAttachmentPgobjects, with proper markdown link formatting. This is consistent with the documentation style used elsewhere.
21-60: Consistent and Detailed Documentation for Remaining PropertiesThe remaining properties—including
createdAt,creator,description,endAt,id,name,organization,startAt,updatedAt, andupdater—are presented with clear type annotations and direct links to their respective definitions. The consistent use of header levels and markdown formatting throughout this section aids in readability and provides a thorough reference for developers.docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md (3)
1-8: Clear Introduction and Header Section
The file begins with a navigation link (“Admin Docs”), a horizontal separator, and a clear header indicating that this document covers the ISO3166Alpha2CountryCode enumeration. The provided link to the source file is useful for developers to trace the definition.
9-10: Well-Defined Enumeration Members Section
The "## Enumeration Members" header clearly delineates the list of country codes. This section title provides an intuitive entry point for readers looking for detailed enumeration documentation.
11-17: Consistent Documentation for Individual Entries (Example: “ad”)
The documentation for the first enumeration member, “ad”, is structured consistently: a third-level header, a blockquote showing the code in bold along with its string literal, and a link referencing the exact definition location in the TypeScript source file. This pattern is repeated for subsequent entries, enhancing readability and traceability.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionEdgePg.md (4)
1-2: Header Link is Clear
The “Admin Docs” link at the top provides an immediate reference to the Admin Docs homepage.
5-8: Interface Title and Source Reference
The title “Interface: InterfaceOrganizationPostsConnectionEdgePg” is clearly stated, and the “Defined in” link (src/utils/interfaces.ts:736) provides a useful reference for traceability.
11-15: Cursor Property Documentation
The documentation for the cursor property is concise and clear—the type is marked asstringand the source reference is provided for quick verification.
19-23: Node Property Documentation
The node property is documented by linking toInterfacePostPg, which helps users quickly navigate to further details about the referenced type.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionEdgePg.md (4)
1-2: Header Link Verification
The “Admin Docs” link is present here as well, ensuring consistency with other documentation pages.
5-8: Interface Title and Source Reference
The header clearly identifies the interface as “Interface: InterfaceOrganizationPinnedPostsConnectionEdgePg” and provides a direct link to its definition in src/utils/interfaces.ts at line 712.
11-15: Cursor Property Documentation
The cursor property is described with its type (string) and a direct source reference, making the documentation both accurate and useful.
19-23: Node Property Documentation
The node property is clearly linked toInterfacePostPg, ensuring that users can easily reference related documentation.docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostPg.md (13)
1-2: Header Link Verification
The introductory “Admin Docs” link is consistently applied, providing a uniform starting point for all documentation pages.
5-8: Interface Title and Source Reference
The interface is titled “Interface: InterfacePostPg” and includes a source reference link to src/utils/interfaces.ts at line 717, which supports easy traceability.
11-16: Caption Property Documentation
The caption property is clearly defined as astringwith an appropriate reference to its source location, ensuring that developers understand its expected format.
17-24: CommentsCount Property Documentation
The commentsCount property is documented as anumber, and the inclusion of the source reference aids in confirming its definition and intent.
27-32: CreatedAt Property Documentation
The createdAt property is described succinctly as astringwith a direct link to its definition, making its purpose clear.
35-40: Creator Property Documentation
The documentation for creator correctly refers toInterfaceUserPgand includes a source reference. This consistency is valuable for maintainability.
43-48: DownVotesCount Property Documentation
The downVotesCount property is precisely documented as anumber, and the source reference confirms its intended usage within the interface.
51-56: ID Property Documentation
The id property is defined as typeIDwith a corresponding source link, ensuring that its expected format is unambiguous.
59-64: Organization Property Documentation
The organization property is well-documented by referencingInterfaceOrganizationPgand by linking to its definition, which enhances the clarity of the data structure.
67-72: PinnedAt Property Documentation
The pinnedAt property is documented as astring, with the source reference provided, making it easy for users to verify its specifics in the source code.
75-80: UpdatedAt Property Documentation
The updatedAt property is clearly defined as astringand the source link validates its documentation, contributing to overall clarity.
83-88: Updater Property Documentation
The updater property is carefully documented with a reference toInterfaceUserPg, ensuring that there is clarity regarding the expected structure of this object.
91-96: UpVotesCount Property Documentation
The upVotesCount property is documented as anumberwith a direct reference to its definition, which reinforces consistency across the documentation.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPg.md (3)
1-8: Clear Header and Interface Definition
The header section "Admin Docs" and the interface title along with its source link are clear and guide the reader efficiently to the source definition.
9-36: Well-Structured Introductory Properties
The "Properties" section, including the introduction of the organization property and the subsequent fields up through theavatarURL, is well-organized with clear type annotations and direct source references.
41-124: Consistent Documentation for Remaining Properties
All subsequent properties—fromcitytovenues—are consistently documented with appropriate type information and hyperlinks. Please verify that all relative links (for example, toIso3166Alpha2CountryCode.md,InterfaceUserPg.md, etc.) correctly resolve in the documentation build.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementAttachmentPg.md (4)
1-4: Doc Header and Navigation Link:
The header uses “Admin Docs” and a horizontal rule to provide clear navigation. The formatting is simple and effective.
5-8: Interface Title & Source Reference:
The interface title “Interface: InterfaceAdvertisementAttachmentPg” and the accompanying source reference link are clearly stated and provide direct traceability to the source code in src/utils/interfaces.ts.
9-16: Property “mimeType” Documentation:
The “mimeType” property is documented concisely by indicating its type as a string and linking to its source definition. This is clear and maintains consistency.
17-23: Property “url” Documentation:
The “url” property is well documented with its type and source reference. The structure helps users verify the property definition directly in the source file.docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementPg.md (13)
1-4: Doc Header and Basic Setup:
The file begins with a clear navigation header and a horizontal separator. This layout is consistent with other admin documentation pages.
5-8: Interface Declaration & Source Link:
The title “Interface: InterfaceAdvertisementPg” and the “Defined in:” link accurately point to the source location (src/utils/interfaces.ts:547). This aids maintainability and cross-referencing.
17-24: “createdAt” Property Documentation:
The documentation for the “createdAt” property is concise and includes both the type and the source reference. This meets documentation standards well.
25-32: “creator” Property Documentation:
The “creator” property is clearly documented, including a link to the InterfaceUserPg documentation. This provides proper cross-reference for further context.
33-40: “description” Property Documentation:
The “description” property is well presented with its type and a direct source reference. The formatting is consistent with other documented properties.
41-48: “endAt” Property Documentation:
Documentation for “endAt” effectively conveys the type information and source location. The section is succinct and clear.
49-56: “id” Property Documentation:
The “id” property is documented by indicating its type as “ID” along with a precise source reference. This consistency aids in maintainability.
57-64: “name” Property Documentation:
The “name” property is clearly documented, providing type information and a link to the corresponding source definition.
65-72: “organization” Property Documentation:
The “organization” property is documented with a link to InterfaceOrganizationPg. The clear reference assists users in navigating related types.
73-80: “startAt” Property Documentation:
This section clearly outlines the “startAt” property with its type and the exact source reference, adhering well to the established documentation style.
81-88: “type” Property Documentation:
The “type” property is documented to reflect its enumeration type (AdvertisementTypePg), along with a source reference. This is appropriately done.
89-96: “updatedAt” Property Documentation:
The “updatedAt” property is consistently documented with its type and source reference, ensuring clarity.
97-104: “updater” Property Documentation:
The “updater” section clearly defines the property with an accompanying link to InterfaceUserPg, mirroring the style of similar properties.docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md (1)
9-9: Validate Updated Definition Location.The updated definition link now points to src/GraphQl/Queries/Queries.ts:475, which correctly reflects the relocation from the previous line.
|
@palisadoes Please check this out. |
|
…wa-admin into api-refactor-1
|
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
src/GraphQl/Queries/Queries.ts (1)
475-528: Rename ORGANIZATIONS_LIST to reflect single organization fetch.The query name suggests fetching multiple organizations, but it's actually fetching a single organization. This mismatch could lead to confusion.
Apply this diff to rename the query:
-export const ORGANIZATIONS_LIST = gql` +export const GET_ORGANIZATION = gql` query Organizations($id: ID!) { organization(id: $id) { _id // ... rest of the fields } } `;Also, consider updating the query operation name to match:
- query Organizations($id: ID!) { + query GetOrganization($id: ID!) {
🧹 Nitpick comments (1)
src/GraphQl/Queries/Queries.ts (1)
388-473: Standardize query naming convention.The queries use inconsistent naming patterns:
getOrganizationPostsCountvsGetOrganizationMembersgetOrganizationDatavsGetOrganizationPostsConsider standardizing the naming convention to use PascalCase for all query names.
Apply this diff to standardize the naming:
- query getOrganizationPostsCount($id: String!) { + query GetOrganizationPostsCount($id: String!) { - query getOrganizationData($id: String!) { + query GetOrganizationData($id: String!) {
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/GraphQl/Queries/Queries.ts(1 hunks)src/screens/OrganizationVenues/OrganizationVenues.spec.tsx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/screens/OrganizationVenues/OrganizationVenues.spec.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test Application
| export const GET_ORGANIZATION_POSTS_COUNT_PG = gql` | ||
| query getOrganizationPostsCount($id: String!) { | ||
| organization(input: { id: $id }) { | ||
| id | ||
| postsCount | ||
| } | ||
| } | ||
| `; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add pagination controls to GET_ORGANIZATION_POSTS_PG query.
The query lacks cursor-based pagination controls (after parameter and pageInfo) that are present in other queries. This inconsistency could lead to performance issues when dealing with large datasets.
Apply this diff to add pagination controls:
export const GET_ORGANIZATION_POSTS_PG = gql`
- query GetOrganizationPosts($id: String!, $first: Int) {
+ query GetOrganizationPosts($id: String!, $first: Int, $after: String) {
organization(input: { id: $id }) {
- posts(first: $first) {
+ posts(first: $first, after: $after) {
edges {
node {
id
caption
createdAt
creator {
id
name
}
}
+ cursor
}
+ pageInfo {
+ hasNextPage
+ endCursor
+ }
}
}
}
`;Also applies to: 444-462
|
@palisadoes Sure, I will sort this ASAP. @gautam-divyanshu Let's collab and solve this faster. |
What kind of change does this PR introduce?
Fix Queries related to
OrganizationDashboard.jsxIssue Number:
Fixes #3487
Does this PR introduce a breaking change?
No
Checklist
CodeRabbit AI Review
Test Coverage
Have you read the contributing guide?
Yes
Summary by CodeRabbit
New Features
UI Improvements
Bug Fixes
OrganizationVenuescomponent to manage test suite stability.