mirror of
https://github.com/AJaySi/ALwrity.git
synced 2026-04-25 08:55:58 +03:00
[GH-ISSUE #258] [FEATURE] Provide ALwrity technical documentation #176
Labels
No labels
AI Content Agents
AI Content Strategy
AI Content planning
AI Marketing Tools
AI SEO
AI personalization
AI writer
ALwrity Copi-lot
Alwrity web search
Anthropic
DeepSeek
Gemini AI
Integration
LLM
OnBoarding
OnBoarding
RAG knowledgebase Memory
bug
documentation
enhancement
good first issue
help wanted
invalid
openai
pull-request
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/ALwrity#176
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @AJaySi on GitHub (Sep 24, 2025).
Original GitHub issue: https://github.com/AJaySi/ALwrity/issues/258
Originally assigned to: @AJaySi on GitHub.
Create a github page for technical documentation of the latest code, getting, started, introduction etc.
@AJaySi commented on GitHub (Sep 24, 2025):
@DikshaDisciplines @Om-Singh1808 @uniqueumesh
Review the new tech doc website.
@uniqueumesh commented on GitHub (Sep 24, 2025):
@AJaySi
I have reviewed the tech doc website and read the document files. Everything looks good to me, and now I am following the steps to install ALwrity locally. Last week, when I tried to install locally, there were a lot of issues, and I was unable to run locally.
@AJaySi commented on GitHub (Sep 24, 2025):
@uniqueumesh
Thanks a lot. I am still re-organizing the documentation and the codebase is a little mess because of today's PR merges.
Please give me till tomorrow afternoon to sort out everything.
I really need your help in deployment. I will update this issue here, once I am done and you can then try it locally.
@AJaySi commented on GitHub (Sep 25, 2025):
I messed up, AI halluicnated and made up features we dont have. But, the good thing is, these are the features we need.
The tech documentation website is a bunch of hallucinations.
This also gives another idea of ALwrity github repo documentation tool.
I have kept the content as it is to move to other things and will have revisit in near future to improve it.
I need to look at exisiting documentation and then move those to mkdocs website. The website workflow code is in .github/workflows folder and is made with mkdocs + github pages. We can add custom domain to it also, its highly SEO optimized. Lets hope this helps in online visibility. If anyone is interested in learning and improving, I can provide getting started info.