ALwrity icon indicating copy to clipboard operation
ALwrity copied to clipboard

[FEATURE] Provide ALwrity technical documentation

Open AJaySi opened this issue 3 months ago • 4 comments

Create a github page for technical documentation of the latest code, getting, started, introduction etc.

AJaySi avatar Sep 24 '25 12:09 AJaySi

@DikshaDisciplines @Om-Singh1808 @uniqueumesh

  • alwrity.com is meant for blogs for non tech audience.
  • https://ajaysi.github.io/ALwrity/ is meant for technical documentation.

Review the new tech doc website.

AJaySi avatar Sep 24 '25 12:09 AJaySi

@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.

uniqueumesh avatar Sep 24 '25 15:09 uniqueumesh

@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 avatar Sep 24 '25 15:09 AJaySi

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.

AJaySi avatar Sep 25 '25 05:09 AJaySi