Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: cms-agilitycms #52867

Open
CraigBC opened this issue Jul 19, 2023 · 5 comments · May be fixed by #72096
Open

Docs: cms-agilitycms #52867

CraigBC opened this issue Jul 19, 2023 · 5 comments · May be fixed by #72096
Labels
examples Issue was opened via the examples template. good first issue Easy to fix issues, good for newcomers

Comments

@CraigBC
Copy link

CraigBC commented Jul 19, 2023

What is the improvement or update you wish to see?

The documentation for AgilityCMS urgently requires comprehensive enhancements. The existing materials impede developers' experiences by necessitating conjectures about the correct steps - this viewpoint comes from a user familiar with the AgilityCMS system. There is an evident disparity between the terminology used in the official documents and that on the AgilityCMS platform itself. This could potentially deter new developers, causing them to abandon their efforts prematurely. Although I've strictly adhered to the NextJS example code and diligently followed the provided tutorial (to the best of my ability given the circumstances), I cannot get this example to work. There is no feedback that even suggests how to fix the error (and I'm guessing even if I fix the "HeroPost" problem, I anticipate more errors to come...)

Far too complicated. Not a positive developer experience.

Is there any context that might help us understand?

Error:

Agility CMS => Fetching sitemap for getAgilityPaths...
Agility CMS => Getting page props for '/'...
- error Error: Could not find a component with the name HeroPost. Tried searching:
        /xxxxx/components/hero-post.tsx',
        /xxxxx/lib/components/hero-post.tsx',
        /xxxxx/components/HeroPost.tsx',
        /xxxxx/lib/components/HeroPost.tsx'.

....it's literally right there under xxxxx/components/hero-post.tsx?

Does the docs page already exist? Please link to it.

https://github.com/vercel/next.js/blob/canary/examples/cms-agilitycms/README.md

@CraigBC CraigBC added the Documentation Related to Next.js' official documentation. label Jul 19, 2023
@balazsorban44 balazsorban44 added good first issue Easy to fix issues, good for newcomers examples Issue was opened via the examples template. and removed Documentation Related to Next.js' official documentation. labels Jul 19, 2023
@shyampathade
Copy link

Can you assign it to me please ?

@anirudhpratap345
Copy link

import HeroPost from '../path/to/components/HeroPost';
Replace '../path/to/components/' with the actual relative path to the directory where the component is located.

@naolmelesse
Copy link

hello @balazsorban44 , can I work on this?

@balazsorban44
Copy link
Member

Feel free to just open a PR and reference this issue. It's generally not required to ask for permission. 🙂

@naolmelesse
Copy link

Feel free to just open a PR and reference this issue. It's generally not required to ask for permission. 🙂

I am new to this. Thanks. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Issue was opened via the examples template. good first issue Easy to fix issues, good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants