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

unfriendly documentation for beginners #356

Open
4A49 opened this issue Apr 6, 2023 · 2 comments
Open

unfriendly documentation for beginners #356

4A49 opened this issue Apr 6, 2023 · 2 comments
Assignees
Labels
feature New feature or request P-Medium Medium Priority

Comments

@4A49
Copy link

4A49 commented Apr 6, 2023

I have been testing your website for like 3 days now but I feel like the documentation does not touch on few things like configuring the database well. for example. you can find something like /posts/126 which they seem to be fetched by some API cos they are not available in the codebase but I can't really tell where they are coming from or how to configure them to use own details or posts. kindly update

@ttttonyhe
Copy link
Owner

@4A49 Thanks for letting me know! Will update the documentation soon.

This repository is the front-end codebase for my blog site, which is powered by WordPress (a content management system). It has a built-in REST API that the front-end can fetch data from. For example, to retrieve the post content for /posts/126, a request is sent to https://blog.ouorz.com/wp-json/wp/v2/posts/126. I also did a lot of customization on the back-end so that the REST APIs could return all the necessary data I needed on the front-end. You may find them here: https://github.com/HelipengTony/ouorz-mono/blob/main/apps/wordpress/wp-content/themes/peg/functions.php.

Hope this information helps you a little bit as you navigate through the codebase. More details will be added to the README soon. Thanks.

@ttttonyhe ttttonyhe added feature New feature or request P-Medium Medium Priority labels Apr 10, 2023
@ttttonyhe ttttonyhe self-assigned this Apr 10, 2023
@4A49
Copy link
Author

4A49 commented Apr 18, 2023

Thank you for responding.it means a lot.
Have a nice time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request P-Medium Medium Priority
Projects
None yet
Development

No branches or pull requests

2 participants