How to add a page to Lucee Docs

documentation
1

How does one go about adding a page to lucee Docs?

A link would suffice.

2

check out the repo and add a file here, follow the other .md files for examples about the meta data required

i.e.

<!--
{
  "title": "AI Augmentation with Lucene",
  "id": "ai-augmentation-lucene",
  "since": "7.0",
  "categories": ["ai", "search"],
  "description": "Documentation for augmenting AI queries using Lucene search in Lucee",
  "keywords": [
    "AI",
    "LLM",
    "RAG",
    "Search",
    "Augmentation",
    "Lucene",
    "Retrieval"
  ]
}
-->

You can also run up it locally, requires Lucee 7, as per the readme

1 Like
3

Nice! I started on some doc updates this spring once it warmed up enough to get outside.

Being able to run things locally to verify it looks correct will be a big help. Going to make an effort to do more this fall/winter when it’s cold and I can’t get out.

It seems like there is some ( a lot) of documentation that is redundant or out dated. What’s the best way to handle those? Maybe post in the forum on feedback if it should be deleted, merged with something else, edited, etc?

I don’t want to spend a lot of time editing something that may be irrelevant LOL

4

My theory/approach is consolidate and improve

If in doubt ask here, otherwise, if you think it makes sense just file a PR

Goal at the moment is migrate content under the recipes

Always open to suggestions!

1 Like