diff --git a/README.md b/README.md index 40c0db9..5ed0403 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,21 @@ ![GitHub top language](https://img.shields.io/github/languages/top/hsjobeki/noogle) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hsjobeki/noogle/main.yml) -### Noogle is a Nix API search engine. It lets you search nix functions. +### Noogle is a simple Nix API search engine. It lets you search nix functions. ## Current Features - [x] Beginners-friendly search for nix and nix-related functions - Render documentation comments optimized for readability + - Search optimized for English language and nix function-names. - [x] Filter by **type** signatures. - Function types are parsed and interpreted. -- [x] Noogle also knows stuff that is not officially documented. +- [x] Noogle also knows stuff that is not (yet) officially documented. - Types of builtins. (including builtins.derivation) - Can be extended via markdown contributions to noogle. - Always shows the latest docs based on the main branch of nixpkgs. - [x] Outputs Pre-rendered static html that is indexable by other search engines. -- [x] Wasm based performant instant search. +- [x] Wasm based performant search. ## Available data diff --git a/website/src/app/md/release/2024-1/page.mdx b/website/src/app/md/release/2024-1/page.mdx index 9b05670..a061c2f 100644 --- a/website/src/app/md/release/2024-1/page.mdx +++ b/website/src/app/md/release/2024-1/page.mdx @@ -56,12 +56,11 @@ The search website has undergone a significant overhaul to highlight the massive Source links point to my autogenerated fork of nixpkgs. -Because: ... +This will be solved within the next weeks. -nixpkgs doesnt officially support markdown in doc-comments yet. Although the RFC145 is accepted things need to be done. +current ly nixpkgs doesnt fully support markdown in doc-comments yet. Although the RFC145 is accepted things need to be done. -The current nixpkgs manual rendering involves ~5k lines of a custom parser written in python. -It fails to generate any output if given real markdown from our doc-comments. Please feel free to contribute there. +Please feel free to contribute there. ## Happy searching!